Viviot.Api

<back to all web services

GetTaskTemplates

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
GET/tasklist/task/templatesGets all task templates in a task list template.
CommonBaseTaskListTemplate Parameters:
NameParameterData TypeRequiredDescription
TaskListTemplateIdformstringYesTasklist template ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<TaskTemplateView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TaskTemplateView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
CompleteWithTagformboolNo
NfcCodeformstringNo
TaskTypeformTaskTypeNo
Orderformlong?No
TaskListTemplateIdformGuidNo
TaskType Enum:
NameValue
Standard0

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.

GET /tasklist/task/templates HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaskTemplatesResponse 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>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.TaskListTemplate">
    <d2p1:TaskTemplateView>
      <d2p1:CompleteWithTag>false</d2p1:CompleteWithTag>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NfcCode>String</d2p1:NfcCode>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:TaskListTemplateId>00000000-0000-0000-0000-000000000000</d2p1:TaskListTemplateId>
      <d2p1:TaskType>Standard</d2p1:TaskType>
    </d2p1:TaskTemplateView>
  </Data>
</TaskTemplatesResponse>