Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.4.0

A pass-through API to ServiceDispatch (when configured) which allows the ServiceDispatch's "Update Problem Info" API to be called. 

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to ServiceDispatch's "Update Problem Info" API

PUT /up/v5/rest/dispatch/updateProblemInfo     

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Code Block
languagejs
{
    "Id": "CT.2019-4-30.100192",
    "MfgSvcrAcct": "FSSTEST",
    "ProbCode": "test1",
    "ProbType": "test1",
    "ProbDesc": "Not working"
}

UpdateProblemInfo Object Properties

PropertyTypeRequired?DescriptionServiceDispatch Field Mapping: ServiceDispatch
IdstringNoPass through parameter to the ServiceDispatch "Update Problem Info" API. CallNo
MfgSvcrAcctstringNo

Pass through parameter to the ServiceDispatch "Update Problem Info" API. 

MfgSvcrAcct
ProbCodestringNo

Pass through parameter to the ServiceDispatch "Update Problem Info" API. 

ProbCode
ProbTypestringNoPass through parameter to the ServiceDispatch "Update Problem Info" API. ProbType
ProbDescstringNoPass 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.

Code Block
languagejs
{
    "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.

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

In addition to the Standard Return Codes, Service Dispatch has unique error codes that can be found here.