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

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

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

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

URL

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

UpdateProductInfo Object Format

{
    "MfgSvcrAcct": "FSSTEST",
    "Id": "CT.2019-4-30.100192",
    "Assets": [
        {
            "Mfg": "GE",
            "ProdLine": "REF",
            "Model": "1125369",
            "SerialNum": "22563666",
            "InServiceDate": "2019-01-01",
            "RetailerId": "test",
            "RetailerName": "test"
        }
    ]
}

UpdateProductInfo Object Properties

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Product Info" API response will be returned.

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

Error

On error, a JSON-formatted version of the ServiceDispatch "Update Product 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 ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.