Viviot.Api

<back to all web services

GetTask

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TaskAdmin
The following routes are available for this service:
GET/tasklist/taskGets a task in a task list.
CommonTask Parameters:
NameParameterData TypeRequiredDescription
TaskIdformstringYesTask ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TaskResponse Parameters:
NameParameterData TypeRequiredDescription
DataformTaskViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TaskView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
CompleteWithTagformboolNo
NfcCodeformstringNo
TaskTypeformTaskTypeNo
Orderformlong?No
TaskStatusformStatusNo
TaskListIdformGuidNo
TaskType Enum:
NameValue
Standard0
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40

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 HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaskResponse 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.TaskList">
    <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:TaskListId>00000000-0000-0000-0000-000000000000</d2p1:TaskListId>
    <d2p1:TaskStatus>ToDo</d2p1:TaskStatus>
    <d2p1:TaskType>Standard</d2p1:TaskType>
  </Data>
</TaskResponse>