POST ShipDlu/Schedule
Request Information
URI Parameters
None.
Body Parameters
ShipDLUScheduleRequestName | Description | Type | Additional information |
---|---|---|---|
ticketType | string |
None. |
|
paxClass | string |
None. |
|
vehicleType | string |
None. |
|
originPort | string |
None. |
|
destinationPort | string |
None. |
|
departStartDate | date |
None. |
|
departEndDate | date |
None. |
|
shipID | string |
None. |
|
userID |
user API |
string |
None. |
accessToken |
access code getting from login |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ticketType": "sample string 1", "paxClass": "sample string 2", "vehicleType": "sample string 3", "originPort": "sample string 4", "destinationPort": "sample string 5", "departStartDate": "2025-01-22T23:55:22.4003443+07:00", "departEndDate": "2025-01-22T23:55:22.4003443+07:00", "shipID": "sample string 8", "userID": "sample string 9", "accessToken": "sample string 10" }
application/xml, text/xml
Sample:
<ShipDLUScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 10</accessToken> <userID>sample string 9</userID> <shipID>sample string 8</shipID> <departEndDate>2025-01-22T23:55:22.4003443+07:00</departEndDate> <departStartDate>2025-01-22T23:55:22.4003443+07:00</departStartDate> <destinationPort>sample string 5</destinationPort> <originPort>sample string 4</originPort> <paxClass>sample string 2</paxClass> <ticketType>sample string 1</ticketType> <vehicleType>sample string 3</vehicleType> </ShipDLUScheduleRequest>
Response Information
Resource Description
ShipDLUScheduleResponseName | Description | Type | Additional information |
---|---|---|---|
schedules | Collection of ShipDLUScheduleModel |
None. |
|
originName | string |
None. |
|
originPort | string |
None. |
|
destinationName | string |
None. |
|
destinationPort | string |
None. |
|
ShipSupplier | integer |
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:
{ "schedules": [ { "originCode": "sample string 1", "destCode": "sample string 2", "ticketType": "sample string 3", "vehicleType": "sample string 4", "paxClass": "sample string 5", "Fares": [ { "Classes": "sample string 1", "PaxType": "sample string 2", "TariffInfo": "sample string 3", "Price": 4.0, "PriceMax": 5.0, "Availability": 6, "Data": "sample string 7", "AvailabilityInfo": "sample string 8", "id": "sample string 9", "count": 10 }, { "Classes": "sample string 1", "PaxType": "sample string 2", "TariffInfo": "sample string 3", "Price": 4.0, "PriceMax": 5.0, "Availability": 6, "Data": "sample string 7", "AvailabilityInfo": "sample string 8", "id": "sample string 9", "count": 10 } ], "shipNumber": "sample string 6", "shipName": "sample string 7", "departDateTime": "2025-01-22T23:55:22.4003443+07:00", "arrivalDateTime": "2025-01-22T23:55:22.4003443+07:00", "routeInfo": "sample string 10" }, { "originCode": "sample string 1", "destCode": "sample string 2", "ticketType": "sample string 3", "vehicleType": "sample string 4", "paxClass": "sample string 5", "Fares": [ { "Classes": "sample string 1", "PaxType": "sample string 2", "TariffInfo": "sample string 3", "Price": 4.0, "PriceMax": 5.0, "Availability": 6, "Data": "sample string 7", "AvailabilityInfo": "sample string 8", "id": "sample string 9", "count": 10 }, { "Classes": "sample string 1", "PaxType": "sample string 2", "TariffInfo": "sample string 3", "Price": 4.0, "PriceMax": 5.0, "Availability": 6, "Data": "sample string 7", "AvailabilityInfo": "sample string 8", "id": "sample string 9", "count": 10 } ], "shipNumber": "sample string 6", "shipName": "sample string 7", "departDateTime": "2025-01-22T23:55:22.4003443+07:00", "arrivalDateTime": "2025-01-22T23:55:22.4003443+07:00", "routeInfo": "sample string 10" } ], "originName": "", "originPort": "sample string 1", "destinationName": "", "destinationPort": "sample string 2", "ShipSupplier": 3, "respTime": "2025-01-22T23:55:22.4003443+07:00", "userID": "sample string 5", "accessToken": "sample string 6", "status": "sample string 7", "respMessage": "sample string 8" }
application/xml, text/xml
Sample:
<ShipDLUScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 6</accessToken> <respMessage>sample string 8</respMessage> <respTime>2025-01-22T23:55:22.4003443+07:00</respTime> <status>sample string 7</status> <userID>sample string 5</userID> <ShipSupplier>3</ShipSupplier> <destinationPort>sample string 2</destinationPort> <originPort>sample string 1</originPort> <schedules> <ShipDLUScheduleModel> <arrivalDateTime>2025-01-22T23:55:22.4003443+07:00</arrivalDateTime> <departDateTime>2025-01-22T23:55:22.4003443+07:00</departDateTime> <routeInfo>sample string 10</routeInfo> <shipName>sample string 7</shipName> <shipNumber>sample string 6</shipNumber> <Fares> <ShipDLUScheduleFareDetail> <Availability>6</Availability> <AvailabilityInfo>sample string 8</AvailabilityInfo> <Classes>sample string 1</Classes> <Data>sample string 7</Data> <PaxType>sample string 2</PaxType> <Price>4</Price> <PriceMax>5</PriceMax> <TariffInfo>sample string 3</TariffInfo> <count>10</count> <id>sample string 9</id> </ShipDLUScheduleFareDetail> <ShipDLUScheduleFareDetail> <Availability>6</Availability> <AvailabilityInfo>sample string 8</AvailabilityInfo> <Classes>sample string 1</Classes> <Data>sample string 7</Data> <PaxType>sample string 2</PaxType> <Price>4</Price> <PriceMax>5</PriceMax> <TariffInfo>sample string 3</TariffInfo> <count>10</count> <id>sample string 9</id> </ShipDLUScheduleFareDetail> </Fares> <destCode>sample string 2</destCode> <originCode>sample string 1</originCode> <paxClass>sample string 5</paxClass> <ticketType>sample string 3</ticketType> <vehicleType>sample string 4</vehicleType> </ShipDLUScheduleModel> <ShipDLUScheduleModel> <arrivalDateTime>2025-01-22T23:55:22.4003443+07:00</arrivalDateTime> <departDateTime>2025-01-22T23:55:22.4003443+07:00</departDateTime> <routeInfo>sample string 10</routeInfo> <shipName>sample string 7</shipName> <shipNumber>sample string 6</shipNumber> <Fares> <ShipDLUScheduleFareDetail> <Availability>6</Availability> <AvailabilityInfo>sample string 8</AvailabilityInfo> <Classes>sample string 1</Classes> <Data>sample string 7</Data> <PaxType>sample string 2</PaxType> <Price>4</Price> <PriceMax>5</PriceMax> <TariffInfo>sample string 3</TariffInfo> <count>10</count> <id>sample string 9</id> </ShipDLUScheduleFareDetail> <ShipDLUScheduleFareDetail> <Availability>6</Availability> <AvailabilityInfo>sample string 8</AvailabilityInfo> <Classes>sample string 1</Classes> <Data>sample string 7</Data> <PaxType>sample string 2</PaxType> <Price>4</Price> <PriceMax>5</PriceMax> <TariffInfo>sample string 3</TariffInfo> <count>10</count> <id>sample string 9</id> </ShipDLUScheduleFareDetail> </Fares> <destCode>sample string 2</destCode> <originCode>sample string 1</originCode> <paxClass>sample string 5</paxClass> <ticketType>sample string 3</ticketType> <vehicleType>sample string 4</vehicleType> </ShipDLUScheduleModel> </schedules> </ShipDLUScheduleResponse>