POST Ship/Schedule

Request Information

URI Parameters

None.

Body Parameters

ShipScheduleRequest
NameDescriptionTypeAdditional information
originPort

string

None.

destinationPort

string

None.

departStartDate

date

None.

departEndDate

date

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",
  "destinationPort": "sample string 2",
  "departStartDate": "2021-11-27T11:59:19.950412+07:00",
  "departEndDate": "2021-11-27T11:59:19.950412+07:00",
  "userID": "sample string 5",
  "accessToken": "sample string 6"
}

application/xml, text/xml

Sample:
<ShipScheduleRequest 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>
  <userID>sample string 5</userID>
  <departEndDate>2021-11-27T11:59:19.950412+07:00</departEndDate>
  <departStartDate>2021-11-27T11:59:19.950412+07:00</departStartDate>
  <destinationPort>sample string 2</destinationPort>
  <originPort>sample string 1</originPort>
</ShipScheduleRequest>

Response Information

Resource Description

ShipScheduleResponse
NameDescriptionTypeAdditional information
originName

string

None.

originPort

string

None.

destinationName

string

None.

destinationPort

string

None.

schedules

Collection of ShipScheduleModel

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:
{
  "originName": "sample string 1",
  "originPort": "sample string 2",
  "destinationName": "sample string 3",
  "destinationPort": "sample string 4",
  "schedules": [
    {
      "shipNumber": "sample string 1",
      "shipName": "sample string 2",
      "departDateTime": "2021-11-27T11:59:19.950412+07:00",
      "arrivalDateTime": "2021-11-27T11:59:19.950412+07:00",
      "originCall": 5,
      "destCall": 6,
      "routeInfo": "sample string 7",
      "scheduleFares": [
        {
          "class": "sample string 1",
          "subClass": "sample string 2",
          "adultFare": 3.0,
          "childFare": 4.0,
          "infantFare": 5.0
        },
        {
          "class": "sample string 1",
          "subClass": "sample string 2",
          "adultFare": 3.0,
          "childFare": 4.0,
          "infantFare": 5.0
        }
      ]
    },
    {
      "shipNumber": "sample string 1",
      "shipName": "sample string 2",
      "departDateTime": "2021-11-27T11:59:19.950412+07:00",
      "arrivalDateTime": "2021-11-27T11:59:19.950412+07:00",
      "originCall": 5,
      "destCall": 6,
      "routeInfo": "sample string 7",
      "scheduleFares": [
        {
          "class": "sample string 1",
          "subClass": "sample string 2",
          "adultFare": 3.0,
          "childFare": 4.0,
          "infantFare": 5.0
        },
        {
          "class": "sample string 1",
          "subClass": "sample string 2",
          "adultFare": 3.0,
          "childFare": 4.0,
          "infantFare": 5.0
        }
      ]
    }
  ],
  "respTime": "2021-11-27T11:59:19.950412+07:00",
  "userID": "sample string 6",
  "accessToken": "sample string 7",
  "status": "sample string 8",
  "respMessage": "sample string 9"
}

application/xml, text/xml

Sample:
<ShipScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 7</accessToken>
  <respMessage>sample string 9</respMessage>
  <respTime>2021-11-27T11:59:19.950412+07:00</respTime>
  <status>sample string 8</status>
  <userID>sample string 6</userID>
  <destinationName>sample string 3</destinationName>
  <destinationPort>sample string 4</destinationPort>
  <originName>sample string 1</originName>
  <originPort>sample string 2</originPort>
  <schedules>
    <ShipScheduleModel>
      <arrivalDateTime>2021-11-27T11:59:19.950412+07:00</arrivalDateTime>
      <departDateTime>2021-11-27T11:59:19.950412+07:00</departDateTime>
      <destCall>6</destCall>
      <originCall>5</originCall>
      <routeInfo>sample string 7</routeInfo>
      <scheduleFares>
        <ShipScheduleFareModel>
          <adultFare>3</adultFare>
          <childFare>4</childFare>
          <classes>sample string 1</classes>
          <infantFare>5</infantFare>
          <subClass>sample string 2</subClass>
        </ShipScheduleFareModel>
        <ShipScheduleFareModel>
          <adultFare>3</adultFare>
          <childFare>4</childFare>
          <classes>sample string 1</classes>
          <infantFare>5</infantFare>
          <subClass>sample string 2</subClass>
        </ShipScheduleFareModel>
      </scheduleFares>
      <shipName>sample string 2</shipName>
      <shipNumber>sample string 1</shipNumber>
    </ShipScheduleModel>
    <ShipScheduleModel>
      <arrivalDateTime>2021-11-27T11:59:19.950412+07:00</arrivalDateTime>
      <departDateTime>2021-11-27T11:59:19.950412+07:00</departDateTime>
      <destCall>6</destCall>
      <originCall>5</originCall>
      <routeInfo>sample string 7</routeInfo>
      <scheduleFares>
        <ShipScheduleFareModel>
          <adultFare>3</adultFare>
          <childFare>4</childFare>
          <classes>sample string 1</classes>
          <infantFare>5</infantFare>
          <subClass>sample string 2</subClass>
        </ShipScheduleFareModel>
        <ShipScheduleFareModel>
          <adultFare>3</adultFare>
          <childFare>4</childFare>
          <classes>sample string 1</classes>
          <infantFare>5</infantFare>
          <subClass>sample string 2</subClass>
        </ShipScheduleFareModel>
      </scheduleFares>
      <shipName>sample string 2</shipName>
      <shipNumber>sample string 1</shipNumber>
    </ShipScheduleModel>
  </schedules>
</ShipScheduleResponse>