Resource URL Summary
Pass Through Call to ServiceDispatch's "Update Problem Info" API
PUT /up/v5/rest/dispatch/updateProblemInfo
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to ServiceDispatch's "Update Problem Info" API
This RESTified API will perform a pass-through call to the ServiceDispatch sub-system's "Update Problem Info" API (when configured).
URL
PUT /up/v5/rest/dispatch/updateProblemInfo
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 ServiceDispatch "Update Problem Info" API.
UpdateProblemInfo Object Format
{ "Id": "CT.2019-4-30.100192", "MfgSvcrAcct": "FSSTEST", "ProbCode": "test1", "ProbType": "test1", "ProbDesc": "Not working" }
UpdateProblemInfo Object Properties
Property | Type | Required? | Description | ServiceDispatch Field Mapping |
---|---|---|---|---|
Id | string | No | Pass through parameter to the ServiceDispatch "Update Problem Info" API. | CallNo |
MfgSvcrAcct | string | No | Pass through parameter to the ServiceDispatch "Update Problem Info" API. | MfgSvcrAcct |
ProbCode | string | No | Pass through parameter to the ServiceDispatch "Update Problem Info" API. | ProbCode |
ProbType | string | No | Pass through parameter to the ServiceDispatch "Update Problem Info" API. | ProbType |
ProbDesc | string | No | Pass through parameter to the ServiceDispatch "Update Problem Info" API. | ProbDesc |
HTTP Response
Success
On success, a JSON-formatted version of the ServiceDispatch "Update Problem 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 ServiceDispatch "Update Problem Info" API response will be returned.
{ "Success": false, "Code": 9, "Payload": { "returnCode": { "type": "Error", "message": "Dispatch Error Code" } } }