Document toolboxDocument toolbox

Get Standard Activity SOAP API

On This Page:

Related Pages:

The sp:ActGetRequest API method can be used to get the details of an existing standard activity.

Description

The sp:ActGetRequest API method allows the details of an existing standard activity to be retrieved.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:ActGetRequest>

 

The meaning of the fields are the same as in a the call to EmpAddActRequest,

 

 

 

<ActNo>?</ActNo>

 

is the unique identifier of the standard activity who field values are to be returned

(tick)

(tick)

</sp:ActGetRequest>

 

 

 

 

Return Structure

The API returns a non-standard return structure.

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:ActGetResponse>

 

 

 

 

 

<ActNo>?</ActNo>

 

 

 

 

 

<ActTypeNum>?</ActTypeNum>

 

 

 

 

 

<Description>?</Description>

ActTypeStr

The description from the Activity type referenced by ActTypeNum

 

 

 

<ExpectedStart>?</ExpectedStart>

 

 

 

 

 

<ExpectedEnd>?</ExpectedEnd>

 

 

 

 

 

<StartLocType>?</StartLocType>

 

 

 

 

 

<StartPostCode>?</StartPostCode>

Postcode

 

 

 

 

<EndLocType>?</EndLocType>

 

 

 

 

 

<EndPostCode>?</EndPostCode>

Postcode

 

 

 

 

<TimeZoneType>?</TimeZoneType>

 

 

 

 

 

<Dispatch>?</Dispatch>

 

 

 

 

 

<TravelMode>?</TravelMode>

 

 

 

 

 

<ExpectedDuration>?</ExpectedDuration>

 

 

 

 

 

<ActNotes>?</ActNotes>

ActNotesActNotes

 

 

 

</sp:ActGetResponse>

 

 

 

 

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

  • SP_ACTIVITY_NO_INVALID (131)