Viviot.Api

CreateTaskLists

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

The following routes are available for this service:
POST	/tasklists	Creates one or more task lists.

**CreateTaskLists** Parameters:
Name	Parameter	Data Type	Required	Description
AccessTemplateGroupId	body	string	No	Access Template Id. Set a value in case the TaskList is relevant to a specific smartspace.
SaveAsTemplate	body	boolean	No	Flag indicating if a template should be saved based on the tasklist being created.
Tasks	body	array	No	Tasks to create as part of the task list.

**CommonTaskListApi** Parameters:
Name	Parameter	Data Type	Required	Description
AccessTemplateId	form	string	No	Access Template Id. Set a value in case the TaskList is relevant to a specific smartspace.
Priority	form	TaskListPriority	Yes	TaskListPriority, ranking this TaskList amid others. Allowable Values None VeryLow Low Medium High VeryHigh Critical
Start	form	string	No	The optional start time of the task list.
Deadline	form	string	No	The optional deadline of the task list.
Categories	form	array	No	Tags under which to categorize the tasklist.
RecurrenceConfiguration	form	string	No	Recurrence configuration in iCalendar format.
ShiftId	form	string	No	ID of a shift that this task list is linked to. If no shift is selected, a user or team must be selected.
TeamId	form	string	No	ID of a team that this task list is linked to. If no team is selected, a user or shift must be selected.
BusinessUserId	form	integer	No	ID 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.
Status	form	Status	Yes	The status/progress of the task list. Allowable Values ToDo InProgress Incomplete Done
Name	form	string	Yes	The base name for this (group of) lists.
Instructions	form	string	No	Instructions on how to complete the task list.

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

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

**Category** Enum:
Name	Value
Cleaning	10
Maintenance	20
Disinfection	30
Inspection	40
Security	50

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

**CommonBaseTask** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Task name.
Description	form	string	No	Task description.
CompleteWithTag	form	boolean	Yes	Flag indicating whether the task completion must be marked by scanning a NFC tag.
NfcCode	form	string	No	NFC code of the tag.
TaskType	form	TaskType	Yes	The type of task. Allowable Values Standard
Order	form	integer	No	The position of the task within its task list.
TaskStatus	form	TaskStatus	Yes	Current status of the task. Allowable Values ToDo InProgress Incomplete Done
TaskListId	form	string	Yes	The ID of the TaskList to which this Task belongs.

**TaskType** Enum:
Name	Value
Standard	0

**TaskListsCreatedResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Ids	form	IEnumerable<Guid>	No

**BaseResponse** Parameters:
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

HTTP + JSV

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

POST /tasklists HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accessTemplateGroupId: 00000000000000000000000000000000,
	saveAsTemplate: False,
	tasks: 
	[
		{
			name: String,
			description: String,
			completeWithTag: False,
			nfcCode: String,
			taskType: 0,
			order: 0,
			taskStatus: 0,
			taskListId: 00000000000000000000000000000000,
			version: 0
		}
	],
	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/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Viviot.Api

CreateTaskLists

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV