Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

5.4.0

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

On this page:

Related pages:

Resource URL Summary

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

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.


API Specifics

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

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

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

Property


TypeRequired?DescriptionServiceDispatch Field Mapping
MfgSvcrAcctstringNo

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

MfgSvcrAcct
IdstringNoPass through parameter to the ServiceDispatch "Update Product Info" API. CallNo
AssetsarrayNo

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



MfgstringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

ProdLinestringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

ModelstringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

SerialNumstringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

InServiceDatestringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

RetailerIdstringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

RetailerNamestringNoPass through parameter to the ServiceDispatch "Update Product Info" API. 

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"
        }
    }
}
  • No labels