POST Ship/Booking

Request Information

URI Parameters

None.

Body Parameters

ShipBookingRequest
NameDescriptionTypeAdditional information
numCode

string

None.

originPort

string

None.

originCall

integer

None.

destinationPort

string

None.

destinationCall

integer

None.

shipNumber

string

None.

departDate

date

None.

paxDetails

Collection of PaxDetail

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",
  "originPort": "sample string 2",
  "originCall": 3,
  "destinationPort": "sample string 4",
  "destinationCall": 5,
  "shipNumber": "sample string 6",
  "departDate": "2021-11-27T11:47:17.2150808+07:00",
  "paxDetails": [
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthDate": "2021-11-27T11:47:17.2150808+07:00",
      "ID": "sample string 4",
      "phone": "sample string 5",
      "paxType": 0,
      "paxGender": 0
    },
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthDate": "2021-11-27T11:47:17.2150808+07:00",
      "ID": "sample string 4",
      "phone": "sample string 5",
      "paxType": 0,
      "paxGender": 0
    }
  ],
  "userID": "sample string 8",
  "accessToken": "sample string 9"
}

application/xml, text/xml

Sample:
<ShipBookingRequest 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-27T11:47:17.2150808+07:00</departDate>
  <destinationCall>5</destinationCall>
  <destinationPort>sample string 4</destinationPort>
  <numCode>sample string 1</numCode>
  <originCall>3</originCall>
  <originPort>sample string 2</originPort>
  <paxDetails>
    <PaxDetail>
      <ID>sample string 4</ID>
      <birthDate>2021-11-27T11:47:17.2150808+07:00</birthDate>
      <firstName>sample string 1</firstName>
      <lastName>sample string 2</lastName>
      <paxGender>M</paxGender>
      <paxType>Adult</paxType>
      <phone>sample string 5</phone>
    </PaxDetail>
    <PaxDetail>
      <ID>sample string 4</ID>
      <birthDate>2021-11-27T11:47:17.2150808+07:00</birthDate>
      <firstName>sample string 1</firstName>
      <lastName>sample string 2</lastName>
      <paxGender>M</paxGender>
      <paxType>Adult</paxType>
      <phone>sample string 5</phone>
    </PaxDetail>
  </paxDetails>
  <shipNumber>sample string 6</shipNumber>
</ShipBookingRequest>

Response Information

Resource Description

ShipBookingResponse
NameDescriptionTypeAdditional information
originPort

string

None.

originCall

integer

None.

destinationPort

string

None.

destinationCall

integer

None.

shipNumber

string

None.

departDate

date

None.

numCode

string

None.

paxBookingDetails

Collection of PaxBookingDetail

None.

salesPrice

decimal number

None.

memberDiscount

decimal number

None.

shipMarkup

decimal number

None.

ticketPrice

decimal number

None.

issuedDateTimeLimit

date

None.

bookingDateTime

date

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-27T11:47:17.2306812+07:00",
  "numCode": "sample string 7",
  "paxBookingDetails": [
    {
      "paxName": "sample string 1",
      "paxType": "sample string 2",
      "paxGender": "sample string 3",
      "birthDate": "2021-11-27T11:47:17.2306812+07:00",
      "ID": "sample string 4",
      "phone": "sample string 5",
      "deck": "sample string 6",
      "cabin": "sample string 7",
      "bed": "sample string 8",
      "fare": 9.0
    },
    {
      "paxName": "sample string 1",
      "paxType": "sample string 2",
      "paxGender": "sample string 3",
      "birthDate": "2021-11-27T11:47:17.2306812+07:00",
      "ID": "sample string 4",
      "phone": "sample string 5",
      "deck": "sample string 6",
      "cabin": "sample string 7",
      "bed": "sample string 8",
      "fare": 9.0
    }
  ],
  "salesPrice": 8.0,
  "memberDiscount": 9.0,
  "shipMarkup": 10.0,
  "ticketPrice": 11.0,
  "issuedDateTimeLimit": "2021-11-27T11:47:17.2306812+07:00",
  "bookingDateTime": "2021-11-27T11:47:17.2306812+07:00",
  "respTime": "2021-11-27T11:47:17.2306812+07:00",
  "userID": "sample string 15",
  "accessToken": "sample string 16",
  "status": "sample string 17",
  "respMessage": "sample string 18"
}

application/xml, text/xml

Sample:
<ShipBookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 16</accessToken>
  <respMessage>sample string 18</respMessage>
  <respTime>2021-11-27T11:47:17.2306812+07:00</respTime>
  <status>sample string 17</status>
  <userID>sample string 15</userID>
  <bookingDateTime>2021-11-27T11:47:17.2306812+07:00</bookingDateTime>
  <departDate>2021-11-27T11:47:17.2306812+07:00</departDate>
  <destinationCall>4</destinationCall>
  <destinationPort>sample string 3</destinationPort>
  <issuedDateTimeLimit>2021-11-27T11:47:17.2306812+07:00</issuedDateTimeLimit>
  <memberDiscount>9</memberDiscount>
  <numCode>sample string 7</numCode>
  <originCall>2</originCall>
  <originPort>sample string 1</originPort>
  <paxBookingDetails>
    <PaxBookingDetail>
      <ID>sample string 4</ID>
      <bed>sample string 8</bed>
      <birthDate>2021-11-27T11:47:17.2306812+07:00</birthDate>
      <cabin>sample string 7</cabin>
      <deck>sample string 6</deck>
      <fare>9</fare>
      <paxGender>sample string 3</paxGender>
      <paxName>sample string 1</paxName>
      <paxType>sample string 2</paxType>
      <phone>sample string 5</phone>
    </PaxBookingDetail>
    <PaxBookingDetail>
      <ID>sample string 4</ID>
      <bed>sample string 8</bed>
      <birthDate>2021-11-27T11:47:17.2306812+07:00</birthDate>
      <cabin>sample string 7</cabin>
      <deck>sample string 6</deck>
      <fare>9</fare>
      <paxGender>sample string 3</paxGender>
      <paxName>sample string 1</paxName>
      <paxType>sample string 2</paxType>
      <phone>sample string 5</phone>
    </PaxBookingDetail>
  </paxBookingDetails>
  <salesPrice>8</salesPrice>
  <shipMarkup>10</shipMarkup>
  <shipNumber>sample string 5</shipNumber>
  <ticketPrice>11</ticketPrice>
</ShipBookingResponse>