POST Ship/Schedule

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
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:

{
  "originPort": "sample string 1",
  "destinationPort": "sample string 2",
  "departStartDate": "2025-01-22T23:53:08.4536635+07:00",
  "departEndDate": "2025-01-22T23:53:08.4536635+07:00",
  "shipID": "sample string 5",
  "userID": "sample string 6",
  "accessToken": "sample string 7"
}

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 7</accessToken>
  <userID>sample string 6</userID>
  <shipID>sample string 5</shipID>
  <departEndDate>2025-01-22T23:53:08.4536635+07:00</departEndDate>
  <departStartDate>2025-01-22T23:53:08.4536635+07:00</departStartDate>
  <destinationPort>sample string 2</destinationPort>
  <originPort>sample string 1</originPort>
</ShipScheduleRequest>

Response Information

Resource Description

ShipScheduleResponse

Name	Description	Type	Additional information
schedules		Collection of ShipScheduleModel	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": [
    {
      "originCall": 1,
      "destCall": 2,
      "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 3",
      "shipName": "sample string 4",
      "departDateTime": "2025-01-22T23:53:08.4536635+07:00",
      "arrivalDateTime": "2025-01-22T23:53:08.4536635+07:00",
      "routeInfo": "sample string 7"
    },
    {
      "originCall": 1,
      "destCall": 2,
      "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 3",
      "shipName": "sample string 4",
      "departDateTime": "2025-01-22T23:53:08.4536635+07:00",
      "arrivalDateTime": "2025-01-22T23:53:08.4536635+07:00",
      "routeInfo": "sample string 7"
    }
  ],
  "originName": "",
  "originPort": "sample string 1",
  "destinationName": "",
  "destinationPort": "sample string 2",
  "ShipSupplier": 3,
  "respTime": "2025-01-22T23:53:08.4536635+07:00",
  "userID": "sample string 5",
  "accessToken": "sample string 6",
  "status": "sample string 7",
  "respMessage": "sample string 8"
}

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 6</accessToken>
  <respMessage>sample string 8</respMessage>
  <respTime>2025-01-22T23:53:08.4536635+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>
    <ShipScheduleModel>
      <arrivalDateTime>2025-01-22T23:53:08.4536635+07:00</arrivalDateTime>
      <departDateTime>2025-01-22T23:53:08.4536635+07:00</departDateTime>
      <routeInfo>sample string 7</routeInfo>
      <shipName>sample string 4</shipName>
      <shipNumber>sample string 3</shipNumber>
      <destCall>2</destCall>
      <originCall>1</originCall>
      <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>
    </ShipScheduleModel>
    <ShipScheduleModel>
      <arrivalDateTime>2025-01-22T23:53:08.4536635+07:00</arrivalDateTime>
      <departDateTime>2025-01-22T23:53:08.4536635+07:00</departDateTime>
      <routeInfo>sample string 7</routeInfo>
      <shipName>sample string 4</shipName>
      <shipNumber>sample string 3</shipNumber>
      <destCall>2</destCall>
      <originCall>1</originCall>
      <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>
    </ShipScheduleModel>
  </schedules>
</ShipScheduleResponse>