Viviot.Api

<back to all web services

UpdateTaskListStatus

Requires Authentication
The following routes are available for this service:
PUT/mobileb/tasklist/statusUpdates the status of a task list.
UpdateTaskListStatus Parameters:
NameParameterData TypeRequiredDescription
TaskListIdbodystringYesTaskList ID
StatusbodyStatusYesThe status/progress of the task list.

Allowable Values

  • ToDo
  • InProgress
  • Incomplete
  • Done
IncompleteReasonbodyIncompleteReasonNoIf 'Status' is set to 'Incomplete', the reason why.

Allowable Values

  • ResourcesMissing
  • PrioritySwitch
  • GuestDeclined
  • FeelingUnwell
  • Other
IncompleteReasonDescriptionbodystringNoIf 'IncompleteReason' is set to 'Other', the reason(s) why.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40
IncompleteReason Enum:
NameValue
ResourcesMissing10
PrioritySwitch20
GuestDeclined30
FeelingUnwell40
Other50
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /mobileb/tasklist/status HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"taskListId":"00000000000000000000000000000000","status":0,"incompleteReason":0,"incompleteReasonDescription":"String","version":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}