Versions Compared

Version Old Version 6 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 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 ServiceDispatchDispatch'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 ServiceDispatch

to Dispatch's "Update Call Status Info" API

This RESTified API will perform a pass-through call to the ServiceDispatch the Dispatch 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 ServiceDispatch the Dispatch "Update Call Status Info" API.

UpdateCallStatusInfo Object Format

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

UpdateCallStatusInfo Object Properties

PropertyTypeRequired?DescriptionDispatch Field Mapping: ServiceDispatch
IdstringNoPass through parameter to the ServiceDispatch "Update Call Status Info" API. 

The call number that was used when the call was originally created.

CallNo
MfgSvcrAcctstringNo

Pass through parameter to the ServiceDispatch "Update Call Status Info" API. This servicer Id given by the requestor but must match data set.

MfgSvcrAcct
CallStatusstringNo

Pass through parameter to the ServiceDispatch "Update Call Status Info" API. The current status of the call. it can be Open or Accepted.

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

This is returned only if the requestor is rejecting/canceling the job on behalf of servicer.

CallReasonCode


HTTP Response

Success

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