Viviot.Api

<back to all web services

GetUnacceptedTaskLists

Requires Authentication
The following routes are available for this service:
GET/mobileb/tasklistsLists task lists that can be accepted by the current user.
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	data: 
	[
		{
			id: 00000000000000000000000000000000,
			taskListAssignee: 
			{
				id: 00000000000000000000000000000000,
				teamId: 00000000000000000000000000000000,
				team: 
				{
					id: 00000000000000000000000000000000,
					name: String
				},
				shiftId: 00000000000000000000000000000000,
				shift: 
				{
					id: 00000000000000000000000000000000,
					organizationId: 00000000000000000000000000000000,
					name: String,
					teamId: 00000000000000000000000000000000,
					startTimeOffset: 0,
					endTimeOffset: 0,
					startDate: -62135596800000,
					endDate: -62135596800000
				},
				businessUser: 
				{
					id: 0,
					name: String
				},
				businessUserId: 0
			},
			accessTemplateId: 00000000000000000000000000000000,
			accessTemplateName: String,
			priority: 0,
			start: -62135596800000,
			deadline: -62135596800000,
			created: -62135596800000,
			recurrenceConfiguration: String,
			status: 0,
			name: String,
			incompleteReason: 0,
			incompleteReasonDescription: String,
			instructions: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}