GET api/SailingSchedule?VoyageNo={VoyageNo}&IncludeCancelled={IncludeCancelled}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VoyageNo

string

Required

IncludeCancelled

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of TVoyageSailingSchedule
NameDescriptionTypeAdditional information
voyage

string

None.

vessel_name

string

None.

port_code

string

None.

port_name

string

None.

eta

string

None.

ets

string

None.

can_load

boolean

None.

can_discharge

boolean

None.

imo_number

string

None.

roro_cutoff

string

None.

last_update

string

None.

call_ref

string

None.

cancelled

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "voyage": "sample string 1",
    "vessel_name": "sample string 2",
    "port_code": "sample string 3",
    "port_name": "sample string 4",
    "eta": "sample string 5",
    "ets": "sample string 6",
    "can_load": true,
    "can_discharge": true,
    "imo_number": "sample string 9",
    "roro_cutoff": "sample string 10",
    "last_update": "sample string 11",
    "call_ref": "sample string 12",
    "cancelled": true
  },
  {
    "voyage": "sample string 1",
    "vessel_name": "sample string 2",
    "port_code": "sample string 3",
    "port_name": "sample string 4",
    "eta": "sample string 5",
    "ets": "sample string 6",
    "can_load": true,
    "can_discharge": true,
    "imo_number": "sample string 9",
    "roro_cutoff": "sample string 10",
    "last_update": "sample string 11",
    "call_ref": "sample string 12",
    "cancelled": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfTVoyageSailingSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EServiceAPI.Models">
  <TVoyageSailingSchedule>
    <call_ref>sample string 12</call_ref>
    <can_discharge>true</can_discharge>
    <can_load>true</can_load>
    <cancelled>true</cancelled>
    <eta>sample string 5</eta>
    <ets>sample string 6</ets>
    <imo_number>sample string 9</imo_number>
    <last_update>sample string 11</last_update>
    <port_code>sample string 3</port_code>
    <port_name>sample string 4</port_name>
    <roro_cutoff>sample string 10</roro_cutoff>
    <vessel_name>sample string 2</vessel_name>
    <voyage>sample string 1</voyage>
  </TVoyageSailingSchedule>
  <TVoyageSailingSchedule>
    <call_ref>sample string 12</call_ref>
    <can_discharge>true</can_discharge>
    <can_load>true</can_load>
    <cancelled>true</cancelled>
    <eta>sample string 5</eta>
    <ets>sample string 6</ets>
    <imo_number>sample string 9</imo_number>
    <last_update>sample string 11</last_update>
    <port_code>sample string 3</port_code>
    <port_name>sample string 4</port_name>
    <roro_cutoff>sample string 10</roro_cutoff>
    <vessel_name>sample string 2</vessel_name>
    <voyage>sample string 1</voyage>
  </TVoyageSailingSchedule>
</ArrayOfTVoyageSailingSchedule>