POST Ship/Issued
Request Information
URI Parameters
None.
Body Parameters
ShipIssuedRequestName | Description | Type | Additional information |
---|---|---|---|
numCode | string |
None. |
|
bookingDate | date |
None. |
|
userID |
user API |
string |
None. |
accessToken |
access code getting from login |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "numCode": "sample string 1", "bookingDate": "2025-01-22T23:54:27.3767125+07:00", "userID": "sample string 3", "accessToken": "sample string 4" }
application/xml, text/xml
Sample:
<ShipIssuedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 4</accessToken> <userID>sample string 3</userID> <bookingDate>2025-01-22T23:54:27.3767125+07:00</bookingDate> <numCode>sample string 1</numCode> </ShipIssuedRequest>
Response Information
Resource Description
ShipIssuedResponseName | Description | Type | Additional information |
---|---|---|---|
originPort | string |
None. |
|
originCall | integer |
None. |
|
destinationPort | string |
None. |
|
destinationCall | integer |
None. |
|
shipNumber | string |
None. |
|
departDate | date |
None. |
|
bookingNumber | string |
None. |
|
bookingDateTime | date |
None. |
|
bookingStatus | string |
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:
{ "originPort": "sample string 1", "originCall": 2, "destinationPort": "sample string 3", "destinationCall": 4, "shipNumber": "sample string 5", "departDate": "2025-01-22T23:54:27.3767125+07:00", "bookingNumber": "sample string 7", "bookingDateTime": "2025-01-22T23:54:27.3767125+07:00", "bookingStatus": "sample string 9", "respTime": "2025-01-22T23:54:27.3767125+07:00", "userID": "sample string 11", "accessToken": "sample string 12", "status": "sample string 13", "respMessage": "sample string 14" }
application/xml, text/xml
Sample:
<ShipIssuedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 12</accessToken> <respMessage>sample string 14</respMessage> <respTime>2025-01-22T23:54:27.3767125+07:00</respTime> <status>sample string 13</status> <userID>sample string 11</userID> <bookingDateTime>2025-01-22T23:54:27.3767125+07:00</bookingDateTime> <bookingNumber>sample string 7</bookingNumber> <bookingStatus>sample string 9</bookingStatus> <departDate>2025-01-22T23:54:27.3767125+07:00</departDate> <destinationCall>4</destinationCall> <destinationPort>sample string 3</destinationPort> <originCall>2</originCall> <originPort>sample string 1</originPort> <shipNumber>sample string 5</shipNumber> </ShipIssuedResponse>