/
_API GetActsRequest Response

_API GetActsRequest Response

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:GetActsResponse>

 

 

 

 

 

<PreAct>?</PreAct>

WorkItemID

is the last activity ID of this batch if more are available

 

 

 

<ActCount>?</ActCount>

int

is the number of activities returned in this batch

 

 

 

<Acts>

 

 

 

 

 

 

<ActNo>?</ActNo>

WorkItemID

is the internal reference number for the activity

 

 

 

 

<ActType>?</ActType>

ActTypeStr

as specified when the activity was defined

 

 

 

 

<ActCategory>?</ActCategory>

ActCategoryDesc

is the text describing the category of the activity type, usually “Other”

 

 

 

 

<Postcode>?</Postcode>

Postcode

is where the activity will take place. Will be blank if this is a locationless Standard Activity.

 

 

 

 

<Operative>?</Operative>

EmpID

is the identifier of the employee whose activities are being listed

 

 

 

 

<ExpectedStart>?</ExpectedStart>

spDateTime

is the scheduled time to start travelling to this activity

 

 

 

 

<ExpectedEnd>?</ExpectedEnd>

spDateTime

is the scheduled time the activity should finish

 

 

 

 

<TravelTime>?</TravelTime>

int

is the expected journey time in minutes from the location of the previous job or activity to this activity

 

 

 

 

<TravelHome>?</TravelHome>

Int

is the expected journey time in minutes from the location of this activity to the operative’s home.

 

 

 

 

<CrewID>?</CrewID>

EmpID

Deprecated

 

 

 

 

<CrewLeader>?</CrewLeader>

Boolean

Deprecated

 

 

 

</Acts>

 

 

 

 

</sp:GetActsResponse>

 

 

 

 

All of the fields to do with dates and times are local to what is specified in the tz_GAAPI database parameter (see [1]). This can be set such that dates and times are local to the timezone of the responsibility unit which contains the standard activity (which is the RU that the employee is posted to at the time of the activity), local to the employee that the activity belongs to, local to a specified or default timezone, or in GMT with or without daylight saving (BST).