Resource URL Summary

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

PUT /up/v5/rest/dispatch/updateConsumerInfo

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

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

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

URL

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

UpdateConsumerInfo Object Format

{
    "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				Type	Required?	Description	Dispatch Field Mapping
`MfgSvcrAcct`				`string`	No	This servicer Id given by the requestor.	`MfgSvcrAcct`
`Id`				`string`	No	The call number that was used when the call was originally created.	`CallNo`
`Location`				`object`	No	Pass through parameter to the Dispatch "Update Consumer Info" API.	`Location`
	`Contacts`			`array`	No	The Contact Information of this customer.	-
		`FirstName`		`string`	No	Consumer First name	`FirstName`
		`LastName`		`string`	No	Consumer Last name	`LastName`
		`ContactPoint`		`array`	No	Pass through parameter to the Dispatch "Update Consumer Info" API.	-
			`Mode`	`string`	No	Pass through parameter to the Dispatch "Update Consumer Info" API.	`Mode`
			`Value`	`string`	No	Pass through parameter to the Dispatch "Update Consumer Info" API.	`Value`
	`Address`			`object`	No	Pass through parameter to the Dispatch "Update Consumer Info" API.	-
		`AddrLine1`		`string`	No	Consumer address.	`Address1`
		`AddrLine2`		`string`	No	Consumer address 2.	`Address2`
		`City`		`string`	No	The city of the Consumer address.	`PostcodeLevel3`
		`Region`		`string`	No	USA = State, UK=Outcode Name	`PostcodeLevel1`
		`Country`		`string`	No	3 Digit UN Country ID	`Country`
		`PostalCode`		`string`	No	USA = State, UK=Outcode Name	`Postcode`

HTTP Response

Success

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

ServiceBroker 5

UpdateConsumerInfo RESTified API

Analytics