Viviot.Api

<back to all web services

GetTeamActiveTaskLists

Requires Authentication
The following routes are available for this service:
GET/mobileb/tasklists/team/activeGets a list of tasklists which start today or later or are not done yet assigned to the teams of the current mobile user with business association.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskListsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<TaskListView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TaskListView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TaskListAssigneeformTaskListAssigneeViewNo
AccessTemplateIdformGuid?No
AccessTemplateNameformstringNo
PriorityformTaskListPriorityNo
StartformDateTimeNo
DeadlineformDateTime?No
CreatedformDateTimeNo
CategoriesformIEnumerable<string>No
RecurrenceConfigurationformstringNo
StatusformStatusNo
NameformstringNo
IncompleteReasonformIncompleteReason?No
IncompleteReasonDescriptionformstringNo
InstructionsformstringNo
TaskListAssigneeView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TeamIdformGuid?No
TeamformTeamBasicViewNo
ShiftIdformGuid?No
ShiftformShiftViewNo
BusinessUserformBusinessUserBasicViewNo
BusinessUserIdformint?No
TeamBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
ShiftView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
TeamIdformGuid?No
StartTimeOffsetformintNo
EndTimeOffsetformintNo
StartDateformDateTime?No
EndDateformDateTime?No
ShiftMembersformIReadOnlyCollection<ShiftMemberView>No
ShiftMemberView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
BusinessUserIdformintNo
ShiftIdformGuidNo
BusinessUserformBusinessUserBasicViewNo
BusinessUserBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TaskListPriority Enum:
NameValue
None0
VeryLow10
Low20
Medium30
High40
VeryHigh50
Critical60
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40
IncompleteReason Enum:
NameValue
ResourcesMissing10
PrioritySwitch20
GuestDeclined30
FeelingUnwell40
Other50

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.

GET /mobileb/tasklists/team/active HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'TaskListsResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)