Resource URL Summary

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

PUT /up/v5/rest/dispatch/getShipmentInfo

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

The parameters date and datetime 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).
`EndDate`	String	Ending date to search for status history (format for this is YYYYDDMM).
`StartTime`	String	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).
`EndDate`	String	Ending date to search for status history (format for this is YYYYDDMM).
`StartTime`	String	Starting time to search for status history (format for this is HH24:MI).
`EndTime`	String	Ending Time to search for status history (format for this is HH24:MI).
`CallStatus`	CallStatusEnquiryReqCallStatus	Limit the search to only a certain status.
`SecStatus`	CallStatusEnquiryReqSecStatus	Limit the search to only a certain secondary status MaxAttempt, Unassigned.

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

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

{
	"Id": "0.616182638892496"
}

GetShipmentInfo Object Properties

Property	Type	Required?	Description	DispatchField Mapping
`Id`	`string`	No	Pass 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.

{
    "AckMsg": "OK",
	"WorkItemCount": "0"
}

Error

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

GetShipmentInfo RESTified API