Versions Compared

Version Old Version 5 New Version 6
Changes made by

Jason Andrew

Jason Andrew

Saved on

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

PUT /up/v5/rest/dispatch/updateConsumerInfo

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics

Panel
borderColor#D3D3D3

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

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/dispatch/updateConsumerInfo

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

UpdateConsumerInfo Object Format

Code Block
languagejs
{
    "MfgSvcrAcct": "FSSTEST",
    "Id": "0.616182638892496",
    "Location": {
        "Contacts": [
            {
                "FirstName": "Cgag",
                "LastName": "greg",
                "ContactPoint": [
                    {
                        "Mode": "Email",
                        "Value": "sp@servicepower.com"
                    },
                    {
                        "Mode": "Phone",
                        "Value": "5022710372"
                    },
                    {
                        "Mode": "Mobile",
                        "Value": "7036369955"
                    },
                    {
                        "Mode": "WorkPhone",
                        "Value": "502271037211"
                    },
                    {
                        "Mode": "WorkPhoneExtn",
                        "Value": "703636995511"
                    }
                ]
            }
        ],
        "Address": {
            "AddrLine1": "379 Wside Dr",
            "AddrLine2": "Ste 888",
            "City": "Gaithesburg",
            "Region": "MD",
            "Country": "USA",
            "PostalCode": "20878"
        }
    }
}

UpdateConsumerInfo Object Properties

Property


TypeRequired?DescriptionServiceDispatch Field Mapping: ServiceDispatch
MfgSvcrAcctstringNo

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

MfgSvcrAcct
IdstringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. CallNo
LocationobjectNo

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

Location

ContactsarrayNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. See below.


FirstNamestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. FirstName


LastNamestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. LastName


ContactPointarrayNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. See below.



ModestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Mode



ValuestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Value

AddressobjectNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. See below.


AddrLine1stringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Address1


AddrLine2stringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Address2


CitystringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. PostcodeLevel3


RegionstringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. PostcodeLevel1


CountrystringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Country


PostalCodestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. Postcode

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Consumer 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 Consumer 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.