Resource URL Summary

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

PUT /up/v5/rest/dispatch/updateCallStatusInfo

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

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

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

URL

PUT /up/v5/rest/dispatch/updateCallStatusInfo

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 Status Info" API.

UpdateCallStatusInfo Object Format

{
    "Id": "CT.2019-4-30.100192",
    "MfgSvcrAcct": "FSSTEST",
    "CallStatus": "ACCEPTED",
    "CallReasonCode": ""
}

UpdateCallStatusInfo 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`
`MfgSvcrAcct`	`string`	No	This servicer Id given by the requestor but must match data set.	`MfgSvcrAcct`
`CallStatus`	`string`	No	The current status of the call. it can be Open or Accepted.	`CallStatus`
`CallReasonCode`	`string`	No	This is returned only if the requestor is rejecting/canceling the job on behalf of servicer.	`CallReasonCode`

HTTP Response

Success

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

{
    "MFGID": "9999",
    "Id": "CT.2019-4-30.100192",
    "AckMsg": "CALL DETAIL UPDTED SUCCESSFUL"
}

Error

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

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}

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.

ServiceBroker 5

UpdateCallStatusInfo RESTified API

Analytics