Viviot.Api

<back to all web services

UpdateTaskList

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
PUT/tasklistUpdates a task list.
UpdateTaskList Parameters:
NameParameterData TypeRequiredDescription
TaskListIdbodystringYesTaskList ID
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.
CommonTaskListApi Parameters:
NameParameterData TypeRequiredDescription
AccessTemplateIdformstringNoAccess Template Id. Set a value in case the TaskList is relevant to a specific smartspace.
PriorityformTaskListPriorityYesTaskListPriority, ranking this TaskList amid others.

Allowable Values

  • None
  • VeryLow
  • Low
  • Medium
  • High
  • VeryHigh
  • Critical
StartformstringNoThe optional start time of the task list.
DeadlineformstringNoThe optional deadline of the task list.
CategoriesformarrayNoTags under which to categorize the tasklist.
RecurrenceConfigurationformstringNoRecurrence configuration in iCalendar format.
ShiftIdformstringNoID of a shift that this task list is linked to. If no shift is selected, a user or team must be selected.
TeamIdformstringNoID of a team that this task list is linked to. If no team is selected, a user or shift must be selected.
BusinessUserIdformintegerNoID of a business user that this task list is directly linked to. If no business user is selected, a team or shift must be selected.
StatusformStatusYesThe status/progress of the task list.

Allowable Values

  • ToDo
  • InProgress
  • Incomplete
  • Done
NameformstringYesThe base name for this (group of) lists.
InstructionsformstringNoInstructions on how to complete the task list.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskListPriority Enum:
NameValue
None0
VeryLow10
Low20
Medium30
High40
VeryHigh50
Critical60
Category Enum:
NameValue
Cleaning10
Maintenance20
Disinfection30
Inspection40
Security50
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 /tasklist HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"taskListId":"00000000000000000000000000000000","incompleteReason":0,"incompleteReasonDescription":"String","accessTemplateId":"00000000000000000000000000000000","priority":0,"start":-62135596800000,"deadline":-62135596800000,"categories":[10],"recurrenceConfiguration":"String","shiftId":"00000000000000000000000000000000","teamId":"00000000000000000000000000000000","businessUserId":0,"status":0,"name":"String","instructions":"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"}}}