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 "Get Shipment 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 "Get Shipment Info" API

PUT /up/v5/rest/dispatch/getShipmentInfo   

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics

The parameters date StartDate and datetime EndDate objects. If your language does not understand these object types, then the definition is included.

CallNo String(20)The call number that was used when the call was originally created.StartDate String(20)

Starting date to search for status history (format for this is YYYYDDMM).

EndDateString

Ending date to search for status history

(format for this is YYYYDDMM).

StartTimeString

Starting time to search for status history

(format for this is HH24:MI)

.


Parameter

Datatype

(length)

Description
CallNo String(20)The call number that was used when the call was originally created.
StartDate String(20)

Starting date to search for status history (format for this is YYYYDDMM).

EndDateString

Ending date to search for status history

(format for this is YYYYDDMM).

StartTimeString

Starting time to search for status history

(format for this is HH24:MI).

EndTimeString

Ending Time to search for status history

(format for this is HH24:MI).

CallStatusCallStatusEnquiryReqCallStatusLimit the search to only a certain status.
SecStatusCallStatusEnquiryReqSecStatusLimit the search to only a certain secondary status MaxAttempt, Unassigned.





Panel
borderColor#D3D3D3

Pass Through Call to Dispatch's "Get Shipment Info" API

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/dispatch/getShipmentInfo

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"Get Shipment Info" API.

GetShipmentInfo Object Format

Code Block
languagejs
{
	"Id": "0.616182638892496"
}

GetShipmentInfo Object Properties

PropertyTypeRequired?DescriptionDispatchField Mapping
IdstringNoPass through parameter to the Dispatch"Get Shipment Info" API. CallNo

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch"Get Shipment Info" API response will be returned.

Code Block
languagejs
{
    "AckMsg": "OK",
	"WorkItemCount": "0"
}

Error

On error, a JSON-formatted version of the Dispatch"Get Shipment 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 DispatchError codes, individual API calls made have unique codes found on their individual pages.