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

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

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

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

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