Pass Through Call to Dispatch's "Re-Notify" API

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

URL

PUT /up/v5/rest/dispatch/getShipmentInfo

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 ServiceBroker "Re-Notify" APi.

ReNotify Object Format

js

ReNotify Object Properties

Property	Type	Required?	Description	Dispatch Field Mapping
`Id`	`string`	No	The call number that was used when the call was originally created.	`CallNo`
`ScvrAcct`	`string`	No	The Account Number of the Service Center.	`MfgSvcrAcct`
`DispatchMode`	`string`	No	Client should select one of the notification methods; Email, Fax, or Default. If the requestor doesn’t know what kind of dispatch notification the servicer has, then the requestor can send the DispMode as Default. Dispatch will then find what kind of dispatch method the servicer selected and send the notification in that method. If servicer doesn’t have any dispatch modes, then it will send error FSS-225.	`DispatchMode`
`AltEmail`	`string`	No	The requestor will send job notifications to a different email (which is not exit in the system).	`AltEmail`
`AltFax`	`string`	No	The requestor will send job notifications to a different Fax(which is not exit in the system).	`AltFax`

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Re-Notify" API response will be returned.

js

Error

On error, a JSON-formatted version of the Dispatch "Re-Notify" 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