Versions Compared

Version Old Version 14 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 Dispatch (when configured) which allows the Dispatch's "Update Call Schedule 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 Dispatch's "Update Call Schedule Info" API

PUT /up/v5/rest/dispatch/updateCallScheduleInfo   

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics  


Panel
borderColor#D3D3D3

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

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/dispatch/updateCallScheduleInfo

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

UpdateCallScheduleInfo Object Format

Code Block
languagejs
{
	"Id": "0.616182638892496",
    "ScheduleDate": "2020-05-13",
    "MfgSvcrAcct": "11154",
    "ScheduleTimePeriod": "6-8",
    "ServiceType": "REP",
    "ServiceSite": "SC"
}

UpdateCallScheduleInfo Object Properties

PropertyTypeRequired?DescriptionDispatch Field Mapping
IdstringNoPass through parameter to the Dispatch "Update Call Schedule Info" API. Unique Id sent when creating the call.CallNo
ScheduleDatestringNoPass through parameter to the Dispatch "Update Call Schedule Info" API. The appointment schedule date.ScheduleDate
MfgSvcrAcctstringNo

Pass through parameter to the Dispatch "Update Call Schedule Info" API. The servicer Id

MfgSvcrAcct
ScheduleTimePeriodstringNo

Pass through parameter to the Dispatch "Update Call Schedule Info" API. The time period the call is scheduled.

ScheduleTimePeriod
ServiceTypestringNoPass through parameter to the Dispatch "Update Call Schedule Info" API. The type of work to be performed (i.e. Repair, Install, Maintenance, Exchange).ServiceType
ServiceSitestringNoPass through parameter to the Dispatch "Update Call Schedule Info" API. 

This defines WHERE the service will be performed (i.e. In Home, Shop, Depot).

ServiceSite

HTTP Response

Success

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

Code Block
languagejs
{
    "MFGID": "9999",
    "Id": "0.616182638892496",
    "AckMsg": "OK"
}

Error

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

Code Block
languagejs
{
    "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.