Viviot.Api

<back to all web services

CreateTaskListTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
POST/tasklist/templateCreates a task list template.
CreateTaskListTemplate Parameters:
NameParameterData TypeRequiredDescription
TaskTemplatesbodyarrayNoTask templates to create as part of the task list template.
CommonTaskListTemplateApi Parameters:
NameParameterData TypeRequiredDescription
PriorityformTaskListPriorityYesTaskListPriority, ranking this tasklist template amid others.

Allowable Values

  • None
  • VeryLow
  • Low
  • Medium
  • High
  • VeryHigh
  • Critical
NameformstringYesThe list template's name.
CategoriesformarrayNoTags under which to categorize the tasklist.
AccessTemplateIdformstringNoAccess template ID.
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
CommonBaseTaskTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesTask template name.
DescriptionformstringNoTask template description.
CompleteWithTagformbooleanYesFlag indicating whether the task completion must be marked by scanning a NFC tag.
NfcCodeformstringNoNFC code of the tag.
TaskTypeformTaskTypeYesThe type of task template.

Allowable Values

  • Standard
OrderformintegerNoThe position of the task template within its task list template.
TaskListTemplateIdformstringYesThe ID of the tasklist template to which this task template belongs.
TaskType Enum:
NameValue
Standard0
TaskListTemplateCreatedResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

POST /tasklist/template HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateTaskListTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <AccessTemplateId>00000000-0000-0000-0000-000000000000</AccessTemplateId>
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Enums">
    <d2p1:Category>Cleaning</d2p1:Category>
  </Categories>
  <Instructions>String</Instructions>
  <Name>String</Name>
  <Priority>None</Priority>
  <TaskTemplates>
    <CommonBaseTaskTemplate>
      <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
      <CompleteWithTag>false</CompleteWithTag>
      <Description>String</Description>
      <Name>String</Name>
      <NfcCode>String</NfcCode>
      <Order>0</Order>
      <TaskListTemplateId>00000000-0000-0000-0000-000000000000</TaskListTemplateId>
      <TaskType>Standard</TaskType>
    </CommonBaseTaskTemplate>
  </TaskTemplates>
</CreateTaskListTemplate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaskListTemplateCreatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</TaskListTemplateCreatedResponse>