Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.4.0

A pass-through API to ServiceBroker to ServiceDispatch (when configured) which allows the ServiceBrokerthe ServiceDispatch's "Update Call Status 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 ServiceBrokerto ServiceDispatch's "Update Call Status Info" API

PUT /up/v5/rest/dispatch/updateCallStatusInfo

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics

Panel
borderColor#D3D3D3

Pass Through Call

to ServiceBroker

to ServiceDispatch's "Update Call Status Info" API

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/dispatch/updateCallStatusInfo

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 ServiceBroker the ServiceDispatch "Update Call Status Info" APiAPI.

UpdateCallStatusInfo Object Format

Code Block
languagejs
{
    "Id": "CT.2019-4-30.100192",
    "MfgSvcrAcct": "FSSTEST",
    "CallStatus": "ACCEPTED",
    "CallReasonCode": ""
}

UpdateCallStatusInfo Object Properties

PropertyTypeRequired?DescriptionServiceDispatch Field Mapping
IdstringNoPass through parameter to the ServiceDispatch "Update Call Status Info" API. CallNo
MfgSvcrAcctstringNo

Pass through parameter to the ServiceDispatch "Update Call Status Info" API. 

MfgSvcrAcct
CallStatusstringNo

Pass through parameter to the ServiceDispatch "Update Call Status Info" API. 

CallStatus
CallReasonCodestringNoPass through parameter to the ServiceDispatch "Update Call Status Info" API. CallReasonCode

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Call Status Info" API response will be returned.

Code Block
languagejs
{
    "MFGID": "9999",
    "Id": "CT.2019-4-30.100192",
    "AckMsg": "CALL DETAIL UPDTED SUCCESSFUL"
}

Error

On error, a JSON-formatted version of the ServiceDispatch "Update Call Status Info" API response will be returned.

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