POST Ship/Availability

Request Information

URI Parameters

None.

Body Parameters

ShipAvailabilityRequest
NameDescriptionTypeAdditional information
originPort

string

None.

originCall

integer

None.

destinationPort

string

None.

destinationCall

integer

None.

shipNumber

string

None.

departDate

date

None.

subClass

string

None.

pax

Collection of Pax

None.

userID

user API

string

None.

accessToken

access code getting from login

string

None.

Request Formats

application/json, text/json

Sample:
{
  "originPort": "sample string 1",
  "originCall": 2,
  "destinationPort": "sample string 3",
  "destinationCall": 4,
  "shipNumber": "sample string 5",
  "departDate": "2021-11-27T07:52:10.7389533+07:00",
  "subClass": "sample string 7",
  "pax": [
    {
      "paxType": 0,
      "paxGender": 0,
      "paxTotal": 1
    },
    {
      "paxType": 0,
      "paxGender": 0,
      "paxTotal": 1
    }
  ],
  "userID": "sample string 8",
  "accessToken": "sample string 9"
}

application/xml, text/xml

Sample:
<ShipAvailabilityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 9</accessToken>
  <userID>sample string 8</userID>
  <departDate>2021-11-27T07:52:10.7389533+07:00</departDate>
  <destinationCall>4</destinationCall>
  <destinationPort>sample string 3</destinationPort>
  <originCall>2</originCall>
  <originPort>sample string 1</originPort>
  <pax>
    <Pax>
      <paxGender>M</paxGender>
      <paxTotal>1</paxTotal>
      <paxType>Adult</paxType>
    </Pax>
    <Pax>
      <paxGender>M</paxGender>
      <paxTotal>1</paxTotal>
      <paxType>Adult</paxType>
    </Pax>
  </pax>
  <shipNumber>sample string 5</shipNumber>
  <subClass>sample string 7</subClass>
</ShipAvailabilityRequest>

Response Information

Resource Description

ShipAvailabilityResponse
NameDescriptionTypeAdditional information
originPort

string

None.

originCall

integer

None.

destinationPort

string

None.

destinationCall

integer

None.

shipNumber

string

None.

departDate

date

None.

subClass

string

None.

availabilityInfo

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": "2021-11-27T07:52:10.7389533+07:00",
  "subClass": "sample string 7",
  "availabilityInfo": "sample string 8",
  "respTime": "2021-11-27T07:52:10.7389533+07:00",
  "userID": "sample string 10",
  "accessToken": "sample string 11",
  "status": "sample string 12",
  "respMessage": "sample string 13"
}

application/xml, text/xml

Sample:
<ShipAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 11</accessToken>
  <respMessage>sample string 13</respMessage>
  <respTime>2021-11-27T07:52:10.7389533+07:00</respTime>
  <status>sample string 12</status>
  <userID>sample string 10</userID>
  <availabilityInfo>sample string 8</availabilityInfo>
  <departDate>2021-11-27T07:52:10.7389533+07:00</departDate>
  <destinationCall>4</destinationCall>
  <destinationPort>sample string 3</destinationPort>
  <originCall>2</originCall>
  <originPort>sample string 1</originPort>
  <shipNumber>sample string 5</shipNumber>
  <subClass>sample string 7</subClass>
</ShipAvailabilityResponse>