Pass Through Call to Dispatch's "Update Call Schedule Info" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Call Schedule Info" API (when configured).

URL

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

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 Dispatch "Update Call Schedule Info" API.

UpdateCallScheduleInfo Object Format

js

UpdateCallScheduleInfo Object Properties

Property	Type	Required?	Description	Dispatch Field Mapping
`Id`	`string`	No	Unique Id sent when creating the call.	`CallNo`
`ScheduleDate`	`string`	No	The appointment schedule date.	`ScheduleDate`
`MfgSvcrAcct`	`string`	No	The servicer Id	`MfgSvcrAcct`
`ScheduleTimePeriod`	`string`	No	The time period the call is scheduled.	`ScheduleTimePeriod`
`ServiceType`	`string`	No	The type of work to be performed (i.e. Repair, Install, Maintenance, Exchange).	`ServiceType`
`ServiceSite`	`string`	No	This defines WHERE the service will be performed (i.e. In Home, Shop, Depot).	`ServiceSite`

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Update Call Schedule Info" API response will be returned.

js

Error

On error, a JSON-formatted version of the Dispatch "Update Call Schedule Info" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.

Browser not supported