Versions Compared

Version Old Version 5 New Version Current
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 Dispatch (when configured) which allows the ServiceDispatchDispatch'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 ServiceDispatchDispatch'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

to Dispatch's "Update Consumer Info" API

This RESTified API will perform a pass-through call to the ServiceDispatch the Dispatch 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 the Dispatch "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 Dispatch Field Mapping
MfgSvcrAcctstringNo

Pass through parameter to the ServiceDispatch "Update Consumer Info" APIThis servicer Id given by the requestor. 

MfgSvcrAcct
IdstringNoPass through parameter to the ServiceDispatch "Update Consumer Info" APIThe call number that was used when the call was originally created. CallNo
LocationobjectNo

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

Location

ContactsarrayNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. See below.The Contact Information of this customer.-


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


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


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



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



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

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


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


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


CitystringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. The city of the Consumer address.PostcodeLevel3


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

USA = State, UK=Outcode Name

PostcodeLevel1


CountrystringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. 3 Digit UN Country IDCountry


PostalCodestringNoPass through parameter to the ServiceDispatch "Update Consumer Info" API. USA = State, UK=Outcode NamePostcode

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch Dispatch "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 Dispatch "Update Consumer Info" API response will be returned.

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

Return Codes

In addition

to

to the Standard Return Codes,

Service Dispatch has unique error codes that can be found here

and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.