POST Ship/Route
Request Information
URI Parameters
None.
Body Parameters
ShipRouteRequestName | Description | Type | Additional information |
---|---|---|---|
userID |
user API |
string |
None. |
accessToken |
access code getting from login |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "userID": "sample string 1", "accessToken": "sample string 2" }
application/xml, text/xml
Sample:
<ShipRouteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 2</accessToken> <userID>sample string 1</userID> </ShipRouteRequest>
Response Information
Resource Description
ShipRouteResponseName | Description | Type | Additional information |
---|---|---|---|
origins | Collection of ShipOriginModel |
None. |
|
destinations | Collection of ShipDestinationModel |
None. |
|
respTime |
describe time in sending response |
date |
None. |
userID |
user ID to access API |
string |
None. |
accessToken |
access token that needed to access API |
string |
None. |
status |
SUCCESS or FAILED |
string |
None. |
respMessage |
detail message of response status |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "origins": [ { "originPort": "sample string 1", "originName": "sample string 2" }, { "originPort": "sample string 1", "originName": "sample string 2" } ], "destinations": [ { "destinationPort": "sample string 1", "destinationName": "sample string 2" }, { "destinationPort": "sample string 1", "destinationName": "sample string 2" } ], "respTime": "2022-05-28T01:24:44.7822221+07:00", "userID": "sample string 2", "accessToken": "sample string 3", "status": "sample string 4", "respMessage": "sample string 5" }
application/xml, text/xml
Sample:
<ShipRouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 3</accessToken> <respMessage>sample string 5</respMessage> <respTime>2022-05-28T01:24:44.7822221+07:00</respTime> <status>sample string 4</status> <userID>sample string 2</userID> <destinations> <ShipDestinationModel> <destinationName>sample string 2</destinationName> <destinationPort>sample string 1</destinationPort> </ShipDestinationModel> <ShipDestinationModel> <destinationName>sample string 2</destinationName> <destinationPort>sample string 1</destinationPort> </ShipDestinationModel> </destinations> <origins> <ShipOriginModel> <originName>sample string 2</originName> <originPort>sample string 1</originPort> </ShipOriginModel> <ShipOriginModel> <originName>sample string 2</originName> <originPort>sample string 1</originPort> </ShipOriginModel> </origins> </ShipRouteResponse>