Description

The sp:ActUpdateRequest allows standard activities to be updated.

Definition

The definition of this API is:

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp:ActUpdateRequest>`
	`<actID>?</actID>`			is the unique identifier of the standard activity to be updated. This is the ID generated by ServiceOptimizer when it was created by a call to EmpAddActRequest and returned in Act.ActNo.
	`<actType>?</actType>`		`ActTypeStr`	If the activity type field is to remain unchanged by this call, the value SP_IntNoUpdate should be supplied, or the field should not be supplied at all for web service.
	`<expectedStart>?</expectedStart>`			If either of these fields is to remain unchanged, the value supplied should be SP_StrNoUpdate, or the field should not be supplied at all for web service.
	`<expectedEnd>?</expectedEnd>`			Act.ExpectedEnd is optional (to allow indefinite standard activities), i.e. it can be set to NULL by supplying an empty string (“”).
	`<locType>?</locType>`		`EmpLocType`	is the new value of the activity’s location. If existing type is not set then an attempt to change this will result in return code SP_ACT_LOC_TYPE_INVALID (152). Similarly, if existing type is set and an attempt is made to change it to not set then this will result in the same return code. If Supplied is supplied, a valid postal code must be supplied in Act.EndPostcode (below). If the location of the activity is to remain unchanged the field should not be supplied at all.	M
	`<locPostcode>?</locPostcode>`		`Postcode`	is ignored unless the supplied value of Act.EndLocType (above) is Supplied, in which case it’s the postal code of the activity’s new location
	`<notes>?</notes>`			is the new value of the user annotation. If SP_StrNoUpdate is supplied (or the field should not be supplied at all for web service), then the existing Notes field remains unchanged. Supplying an empty string (“”) will effectively remove an existing Notes field.
	`<TZType>?</TZType>`		`StandardActivityTZType`	is ignored if neither expectedStart or expectedEnd is supplied. Defaults to Employee TZ if nothing specified.
	`<Dispatch>?</Dispatch>`			SP_SA_DISPATCH_CANNOT_CHANGE (668)will be returned if set differently to existing value.
	`<TravelMode>?</TravelMode>`		`StandardActivityTravelMode`	SP_SA_TRAVELMODE_CANNOT_CHANGE (669)will be returned if set differently to existing value.
	`<Duration>?</Duration>`			The number of minutes the standard activity is expected to last. expectedEnd and expectedDuration cannot both be populated – if both are then SP_SA_CONFLICTING_END (665) will be returned.
	`<options>`			Please refer to section 4.2.4for defintions and settings values
		`<CheckJobs>?</CheckJobs>`
		`<CheckStdActs>?</CheckStdActs>`
		`<CheckJobsDealloc>?</CheckJobsDealloc>`
		`<CheckJobsShuffle>?</CheckJobsShuffle>`
		`<CheckJobsAllowBreakAH>?</CheckJobsAllowBreakAH>`
		`<CheckFrozen>?</CheckFrozen>`
		`<OverlapBreaks>?</OverlapBreaks>`
	`</options>`
`</sp:ActUpdateRequest>`

Return Structure

The API returns the standard return structure.

Return Codes

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

Click here to expand...

SP_POSTCODE_INVALID (3)
SP_DURATION_INVALID (12)
SP_END_NOT_GT_START_TIME (31)
SP_OUTSIDE_HORIZON (53)
SP_START_TIME_INVALID (62)
SP_END_TIME_INVALID (63)
SP_OPTIONS_INVALID (80)
SP_NO_REG_TO_RU_MAPPING (115)
SP_ACTIVITY_TYPE_INVALID (120)
SP_ACTIVITY_NOTES_INVALID (123)
SP_ACTIVITY_NO_INVALID (131)
SP_OVERLAPPED_JOBS (132)
SP_ACT_LOC_TYPE_INVALID (152)
SP_OPTION_COMBINATION_INVALID (159)
SP_OVERLAPPED_STDACTS (160)
SP_POSTING_HAS_ENDDATE (285)
SP_SPANS_POSTINGS (286)
SP_WOULD_BREAK_ACCESS_HOURS (371)
SP_OK_WITH_OVERLAPS (373)
SP_DST_TIME_INVALID (379)
SP_FROZEN_DAY (585)
SP_OK_CAPACITY_EXCEEDED (640)
SP_SA_CONFLICTING_END (665)
SP_SA_DISPATCH_CANNOT_CHANGE (668)
SP_SA_TRAVELMODE_CANNOT_CHANGE (669)
SP_SA_DISPATCH_INVALID (670)
SP_SA_LOCATIONTYPE_MISSING_POSTCODE (673)

Browser not supported