Viviot.Api

GetTaskLists

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin, TaskAdmin

The following routes are available for this service:
GET	/tasklists	Gets all task lists for the current user's organization.

**GetTaskLists** Parameters:
Name	Parameter	Data Type	Required	Description
From	query	string	No	Gets or sets from when to return tasklists for (UTC).
To	query	string	No	Gets or sets until when to return tasklists for (UTC).

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**TaskListsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<TaskListView>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**TaskListView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
TaskListAssignee	form	TaskListAssigneeView	No
AccessTemplateId	form	Guid?	No
AccessTemplateName	form	string	No
Priority	form	TaskListPriority	No
Start	form	DateTime	No
Deadline	form	DateTime?	No
Created	form	DateTime	No
Categories	form	IEnumerable<string>	No
RecurrenceConfiguration	form	string	No
Status	form	Status	No
Name	form	string	No
IncompleteReason	form	IncompleteReason?	No
IncompleteReasonDescription	form	string	No
Instructions	form	string	No

**TaskListAssigneeView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
TeamId	form	Guid?	No
Team	form	TeamBasicView	No
ShiftId	form	Guid?	No
Shift	form	ShiftView	No
BusinessUser	form	BusinessUserBasicView	No
BusinessUserId	form	int?	No

**TeamBasicView** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	No

**ShiftView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
TeamId	form	Guid?	No
StartTimeOffset	form	int	No
EndTimeOffset	form	int	No
StartDate	form	DateTime?	No
EndDate	form	DateTime?	No
ShiftMembers	form	IReadOnlyCollection<ShiftMemberView>	No

**ShiftMemberView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
BusinessUserId	form	int	No
ShiftId	form	Guid	No
BusinessUser	form	BusinessUserBasicView	No

**BusinessUserBasicView** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No

**TaskListPriority** Enum:
Name	Value
None	0
VeryLow	10
Low	20
Medium	30
High	40
VeryHigh	50
Critical	60

**Status** Enum:
Name	Value
ToDo	0
InProgress	10
Incomplete	30
Done	40

**IncompleteReason** Enum:
Name	Value
ResourcesMissing	10
PrioritySwitch	20
GuestDeclined	30
FeelingUnwell	40
Other	50

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 /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
		}
	}
}