Viviot.Api

<back to all web services

CreateTaskTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
POST/tasklist/task/templateCreates a task template in a task list template.
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.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskType Enum:
NameValue
Standard0
IdResponse 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/task/template HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<IdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <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>
</IdResponse>