| PUT | /mobileb/tasklist/status | Updates the status of a task list. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaskListId | body | string | Yes | TaskList ID |
| Status | body | Status | Yes | The status/progress of the task list.Allowable Values
|
| IncompleteReason | body | IncompleteReason | No | If 'Status' is set to 'Incomplete', the reason why.Allowable Values
|
| IncompleteReasonDescription | body | string | No | If 'IncompleteReason' is set to 'Other', the reason(s) why. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| ToDo | 0 |
| InProgress | 10 |
| Incomplete | 30 |
| Done | 40 |
| Name | Value |
|---|---|
| ResourcesMissing | 10 |
| PrioritySwitch | 20 |
| GuestDeclined | 30 |
| FeelingUnwell | 40 |
| Other | 50 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
taskListId: 00000000000000000000000000000000,
status: 0,
incompleteReason: 0,
incompleteReasonDescription: String,
version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}