POST Ship/List
Request Information
URI Parameters
None.
Body Parameters
ShipRequestName | 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:
<ShipRequest 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> </ShipRequest>
Response Information
Resource Description
ShipResponseName | Description | Type | Additional information |
---|---|---|---|
ships | Collection of ShipModel |
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:
{ "ships": [ { "name": "sample string 1", "id": "sample string 2" }, { "name": "sample string 1", "id": "sample string 2" } ], "respTime": "2025-01-22T23:52:47.1169637+07:00", "userID": "sample string 2", "accessToken": "sample string 3", "status": "sample string 4", "respMessage": "sample string 5" }
application/xml, text/xml
Sample:
<ShipResponse 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>2025-01-22T23:52:47.1169637+07:00</respTime> <status>sample string 4</status> <userID>sample string 2</userID> <ships> <ShipModel> <id>sample string 2</id> <name>sample string 1</name> </ShipModel> <ShipModel> <id>sample string 2</id> <name>sample string 1</name> </ShipModel> </ships> </ShipResponse>