GetTask()

Returns a single Task with its attributes.

  • Quota: 1
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
taskIdstring20YThe 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.
Table 2. TaskInformation
ParameterTypeMax LengthAllow NULLDescription
TaskIDstring20The unique ID of the task.
TaskTypeLinkIDintegerThe task type link ID of the task type.The task type link id will go across versions of the task type.
Locationstring100The location where the task was raised.
Descriptionstring1000The description of the task.
Statusstring100The current status of the task.
StatusColourstring50The status colour of the task.
StatusDateDateTimeThe date when the task was changed to this status.
IssuedDateDateTimeThe date the tasks was issued / created.
TaskTypestring 100The task type.
IssuedToPackageIDintegerYThe package id the task is issued to. Get the package trades using GetPackageTrades().
IssuedToPackagestring100The package description the task is issued to.
IssuedToOrganisationstring100The organisation name the task is issued to.
TargetDateDateTimeThe target date the task should be closed by.
IssuedByUserstring100The name of the person that issued the task.
IssuedByOrganisationstring100The name of the organisation that issued the task.
IssuedByOrganisationTypestring100The organisation type that issued the task.
Prioritystring100The priority the task should given.
Causestring100The cause description.
CausedByOrganisationstring100The name of the organisation that caused this task to be issued/created.
ActualStartDateDateTimeYThe date the task was actually started.
ActualFinishDateDateTimeYThe date the task was actually closed. Only valid for process tasks.
CostintegerYThe cost this task incurred.
OverDuebooleanIs the task still open and target date has passed.
CompletebooleanHas the task been completed.
ClosedbooleanHas the task been closed.
Resolutionstring1000A comment on how the task was resolved.
LastModifiedDateTimeThe date that the task was last modified.
Scorestring100YThe score assigned to the task.
GPSLatitudedecimalYThe GPS latitude of the mobile device user when they fill out this question in the form.
GPSLongitudedecimalYThe GPS longitude of the mobile device user when they fill out this question in the form.
PercentageCompletedecimalY

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.

PlannedStartDateDateTimeYThe date the task is planned to start.
FormIdstringThe Form or Form Answer to which the Task is related.
DeletedbooleanHas the Task been deleted.
LastModifiedOnServerDateTimeTime 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>