GetTask()
Returns a single Task with its attributes.
|
Parameter | Type | Max Length | Required | Description |
---|---|---|---|---|
apiToken | string | 20 | Y | Your API security token configured in Field View. |
taskId | string | 20 | Y | The Task ID. |
Note: At least one date range is required and none
may be greater than 3 months. If you provide more than one date
range in the same call, the system returns only results that meet
both ranges, thereby potentially narrowing your results.
|
Parameter | Type | Max Length | Allow NULL | Description |
---|---|---|---|---|
TaskID | string | 20 | The unique ID of the task. | |
TaskTypeLinkID | integer | The task type link ID of the task type.The task type link id will go across versions of the task type. | ||
Location | string | 100 | The location where the task was raised. | |
Description | string | 1000 | The description of the task. | |
Status | string | 100 | The current status of the task. | |
StatusColour | string | 50 | The status colour of the task. | |
StatusDate | DateTime | The date when the task was changed to this status. | ||
IssuedDate | DateTime | The date the tasks was issued / created. | ||
TaskType | string | 100 | The task type. | |
IssuedToPackageID | integer | Y | The package id the task is issued to. Get the package trades using GetPackageTrades(). | |
IssuedToPackage | string | 100 | The package description the task is issued to. | |
IssuedToOrganisation | string | 100 | The organisation name the task is issued to. | |
TargetDate | DateTime | The target date the task should be closed by. | ||
IssuedByUser | string | 100 | The name of the person that issued the task. | |
IssuedByOrganisation | string | 100 | The name of the organisation that issued the task. | |
IssuedByOrganisationType | string | 100 | The organisation type that issued the task. | |
Priority | string | 100 | The priority the task should given. | |
Cause | string | 100 | The cause description. | |
CausedByOrganisation | string | 100 | The name of the organisation that caused this task to be issued/created. | |
ActualStartDate | DateTime | Y | The date the task was actually started. | |
ActualFinishDate | DateTime | Y | The date the task was actually closed. Only valid for process tasks. | |
Cost | integer | Y | The cost this task incurred. | |
OverDue | boolean | Is the task still open and target date has passed. | ||
Complete | boolean | Has the task been completed. | ||
Closed | boolean | Has the task been closed. | ||
Resolution | string | 1000 | A comment on how the task was resolved. | |
LastModified | DateTime | The date that the task was last modified. | ||
Score | string | 100 | Y | The score assigned to the task. |
GPSLatitude | decimal | Y | The GPS latitude of the mobile device user when they fill out this question in the form. | |
GPSLongitude | decimal | Y | The GPS longitude of the mobile device user when they fill out this question in the form. | |
PercentageComplete | decimal | Y |
Mobile users can edit this field. When you close out the process task, the system sets this field to 100. These values aren't visible in web tasks or reports, but you can opt to add “Percentage Complete” column to the grid and see the values there. |
|
PlannedStartDate | DateTime | Y | The date the task is planned to start. | |
FormId | string | The Form or Form Answer to which the Task is related. | ||
Deleted | boolean | Has the Task been deleted. | ||
LastModifiedOnServer | DateTime | Time stamp of the last update to this Task. |
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetTaskResponse xmlns="https://localhost.priority1.uk.net/Priority1WebServices/XML">
<GetTaskResult>
<TaskInformationResponse xmlns="">
<Status>
<Code>SUCCESS</Code>
<Message>Success. [ActivityId]: eaedfccf-0bbd-47fe-a4ea-7da7cb1058c1</Message>
</Status>
<TaskInformationItem>
<TaskID></TaskID>
<TaskTypeLinkID></TaskTypeLinkID>
<Location></Location>
<Description></Description>
<Status></Status>
<StatusColour></StatusColour>
<StatusDate></StatusDate>
<IssuedDate></IssuedDate>
<TaskType></TaskType>
<IssuedToPackageID></IssuedToPackageID>
<IssuedToPackage></IssuedToPackage>
<IssuedToOrganisation></IssuedToOrganisation>
<TargetDate xsi:nil="true"/>
<IssuedByUser></IssuedByUser>
<IssuedByOrganisation>H</IssuedByOrganisation>
<IssuedByOrganisationType></IssuedByOrganisationType>
<ActualStartDate xsi:nil="true"/>
<ActualFinishDate xsi:nil="true"/>
<Cost xsi:nil="true"/>
<OverDue></OverDue>
<Complete></Complete>
<Closed></Closed>
<LastModified></LastModified>
<Score/>
<GPSLatitude xsi:nil="true"/>
<GPSLongitude xsi:nil="true"/>
<PercentageComplete>0.00</PercentageComplete>
<PlannedStartDate xsi:nil="true"/>
<FormId/>
<Deleted></Deleted>
<LastModifiedOnServer></LastModifiedOnServer>
</TaskInformationItem>
</TaskInformationResponse>
</GetTaskResult>
</GetTaskResponse>
</soap:Body>
</soap:Envelope>