Pass Through Call to Scheduling's "ActUpdateRequest" API

This RESTified API will perform a pass-through call to the Scheduling sub-system's "ActUpdateRequest" API (when configured).

URL

PUT /up/v5/rest/scheduling/ActUpdateRequest

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Scheduling "ActUpdateRequest" API.

ActUpdate Object Format

ActUpdate JSON

js

ActUpdate Object Properties

Property	Type	Length	Description	Req?	ServiceDispatch Field Mapping
actID	string	n/a	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.	Yes	actID
actType	string	max 30	Type of Standard Activity Being Created/Updated 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.	Yes	ActTypeStr
expectedStart	string	8	Date and time of when the new standard activity should start (employee local or default – see 12). If the time part isn’t supplied, it defaults to the start of the operative’s day. Local to the employee doing the activity or, if the employee has no timezone, local to the default timezone. Example: "2023-03-30"	Yes	expectedStart
expectedEnd	string	8	Date and time (employee local or default) when the new standard activity should end. If the time part isn’t supplied, it defaults to the end of the operative’s day. If an empty string (“”) is supplied, the new activity will last indefinitely but this is only allowed if the employee is posted to the same FRU (but not necessarily to the same Team within that FRU) indefinitely, otherwise SP_POSTING_HAS_ENDDATE (285) will be returned. expectedEnd and expectedDuration cannot both be populated – if both are then SP_SA_CONFLICTING_END (665) will be returned. Local to the employee doing the activity or, if the employee has no timezone, local to the default timezone. Example: "2023-03-30"	Yes	expectedEnd
locType	string SS: EmpLocType		Specifies where the new standard activity is to be located: at a supplied postal code (in Act.EndPostCode (below)), at the employee’s home region, at the employee’s depot’s region (not available in V4.4 if the operative isn’t on shift), at the employee’s work region, at the employee’s start region on the day of the activity (if he’s on shift), taking overrides into account, at the employee’s end region on the day of the activity (if he’s on shift), taking overrides into account Note: Can be missing but, unless StandardActivityTravelMode has a value other than NoTravel, this will result in SP_ACT_LOC_TYPE_INVALID (152) being returned, since the activity’s location must be known to SERVICEOptimizer for travel to be included. SS Valid Values: "Home", "Work", "Depot", "Supplied", "None"	Yes	locType
Postcode	string		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	string	SS: 503	This field is for user annotation and can either be any text string or it can be empty (“”). It appears on the Gantt Show Activity Details window, where it can also be edited.	Yes	notes
TZType	string		Defaults to Employee TZ. SS Valid Values: "Home", "FRU", "Location", "Default"	Yes	ActTZType
Dispatch	boolean		Determines whether or not this specific standard activity will be included in any dispatching process. Defaults to value associated with actType.	Yes	Dispatch
TravelMode	string		Determines whether the standard activity will be allocated travel and, if so, how that travel behaves w.r.t the start of the SA SS Valid Values: "None", "ETS", "ETA"	Yes	StandardActivityTravelMode
Duration	string		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.	Yes	Duration
Options	object		The Options.Objects available from ActUpdate.	No	see: ActUpdate.Options

HTTP Response

Success

On success, a JSON-formatted version of the Scheduling "ActUpdateRequest" API response will be returned.

js

Error

On error, a JSON-formatted version of the Scheduling "ActUpdateRequest" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, and the Scheduling Error codes, the possible Return Codes from this API are:

SP_POSTCODE_INVALID (3)
SP_EMPID_INVALID (5)
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_EMP_NOT_IN_TEAM (124)
SP_TEAM_NOT_IN_RU (125)
SP_OVERLAPPED_JOBS (132)
SP_ACT_LOC_TYPE_INVALID (152)
SP_OPTION_COMBINATION_INVALID (159)
SP_OVERLAPPED_STDACTS (160)
SP_EMPID_DOES_NOT_EXIST (231)
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_SATM_INVALID (667)
SP_SA_DISPATCH_INVALID (670)
SP_SA_TRAVELMODE_ENDTIME_INVALID (672)
SP_SA_LOCATIONTYPE_MISSING_POSTCODE (673)

Browser not supported