POST Ship/GetRoom

Request Information

URI Parameters

None.

Body Parameters

ShipGetRoomRequest
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.

ticketBuyerName

string

None.

ticketBuyerEmail

string

None.

ticketBuyerAddress

string

None.

ticketBuyerPhone

string

None.

family

boolean

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-27T10:40:24.839002+07:00",
  "subClass": "sample string 7",
  "pax": [
    {
      "paxType": 0,
      "paxGender": 0,
      "paxTotal": 1
    },
    {
      "paxType": 0,
      "paxGender": 0,
      "paxTotal": 1
    }
  ],
  "ticketBuyerName": "sample string 8",
  "ticketBuyerEmail": "sample string 9",
  "ticketBuyerAddress": "sample string 10",
  "ticketBuyerPhone": "sample string 11",
  "family": true,
  "userID": "sample string 13",
  "accessToken": "sample string 14"
}

application/xml, text/xml

Sample:
<ShipGetRoomRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 14</accessToken>
  <userID>sample string 13</userID>
  <departDate>2021-11-27T10:40:24.839002+07:00</departDate>
  <destinationCall>4</destinationCall>
  <destinationPort>sample string 3</destinationPort>
  <family>true</family>
  <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>
  <ticketBuyerAddress>sample string 10</ticketBuyerAddress>
  <ticketBuyerEmail>sample string 9</ticketBuyerEmail>
  <ticketBuyerName>sample string 8</ticketBuyerName>
  <ticketBuyerPhone>sample string 11</ticketBuyerPhone>
</ShipGetRoomRequest>

Response Information

Resource Description

ShipGetRoomResponse
NameDescriptionTypeAdditional information
originPort

string

None.

originCall

integer

None.

destinationPort

string

None.

destinationCall

integer

None.

shipNumber

string

None.

departDate

date

None.

ticketBuyerName

string

None.

ticketBuyerEmail

string

None.

ticketBuyerAddress

string

None.

ticketBuyerPhone

string

None.

numCode

string

None.

rooms

Collection of Room

None.

bookTimeLimit

integer

None.

ticketPrice

decimal number

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-27T10:40:24.8546024+07:00",
  "ticketBuyerName": "sample string 7",
  "ticketBuyerEmail": "sample string 8",
  "ticketBuyerAddress": "sample string 9",
  "ticketBuyerPhone": "sample string 10",
  "numCode": "sample string 11",
  "rooms": [
    {
      "deck": "sample string 1",
      "cabin": "sample string 2",
      "bed": "sample string 3"
    },
    {
      "deck": "sample string 1",
      "cabin": "sample string 2",
      "bed": "sample string 3"
    }
  ],
  "bookTimeLimit": 12,
  "ticketPrice": 13.0,
  "respTime": "2021-11-27T10:40:24.8546024+07:00",
  "userID": "sample string 15",
  "accessToken": "sample string 16",
  "status": "sample string 17",
  "respMessage": "sample string 18"
}

application/xml, text/xml

Sample:
<ShipGetRoomResponse 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-27T10:40:24.8546024+07:00</respTime>
  <status>sample string 17</status>
  <userID>sample string 15</userID>
  <bookTimeLimit>12</bookTimeLimit>
  <departDate>2021-11-27T10:40:24.8546024+07:00</departDate>
  <destinationCall>4</destinationCall>
  <destinationPort>sample string 3</destinationPort>
  <numCode>sample string 11</numCode>
  <originCall>2</originCall>
  <originPort>sample string 1</originPort>
  <rooms>
    <Room>
      <bed>sample string 3</bed>
      <cabin>sample string 2</cabin>
      <deck>sample string 1</deck>
    </Room>
    <Room>
      <bed>sample string 3</bed>
      <cabin>sample string 2</cabin>
      <deck>sample string 1</deck>
    </Room>
  </rooms>
  <shipNumber>sample string 5</shipNumber>
  <ticketBuyerAddress>sample string 9</ticketBuyerAddress>
  <ticketBuyerEmail>sample string 8</ticketBuyerEmail>
  <ticketBuyerName>sample string 7</ticketBuyerName>
  <ticketBuyerPhone>sample string 10</ticketBuyerPhone>
  <ticketPrice>13</ticketPrice>
</ShipGetRoomResponse>