Get Sailing schedule
API Version: v1.0
Overview
The Sailing schedule API allows you to choose the desired loading and discharging ports to check available voyages based on the below parameters.
Sample Request
HTTP
GET https://app.logisoft.io/api/voyage/schedule
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | Successful operation |
Parameters
Name | Required | Type | Description |
---|---|---|---|
ScheduleCategory | false | string | Trade routes e.g. USA, Europe, etc. |
PolContinent | Enum | Continent? | The continent where the Pol is located |
Pol | true | string | The name of the port of loading |
Pod | true | string | The name of the port of discharge |
Vessel | false | string | The vessel’s name |
Voyage | false | string | The voyage number |
ArrivalMin | false | DateTime | Minimum arrival date/time to ports of discharge |
ArrivalMax | false | DateTime | Maximum arrival date/time to ports of discharge |
DepartureMin | false | DateTime | Minimum departure date/time from ports of loading |
DepartureMax | false | DateTime | Maximum departure date/time from ports of loading |
Line | false | string | The name of the Shipping Line |
Sample Response
Status code: 200
JSON
{ "entries": [ { "voyage": "GGA2712", "vessel": "Grande Gabon", "port": "Antwerp", "arrival": "2014-12-25T00:00:00", "departure": "2014-12-27T00:00:00", "cutOff": null }, { "voyage": "GTE3101", "vessel": "Grande Tema", "port": "Antwerp", "arrival": "2015-01-29T00:00:00", "departure": "2015-01-31T00:00:00", "cutOff": null }, { "voyage": "GIT0105", "vessel": "Grande Italia", "port": "Antwerp", "arrival": "2015-04-30T00:00:00", "departure": "2015-05-02T00:00:00", "cutOff": null } ] }
Properties
Response
Name | Type | Description |
---|---|---|
Entries | ScheduleEntry[] | The ScheduleEntry list |
ScheduleEntry
Name | Type | Description |
---|---|---|
Voyage | string | The voyage number |
Vessel | string | The vessel name |
Port | string | The name of the port |
Arrival | DateTime | The vessel’s Arrival date/time to the port |
Departure | DateTime | The vessel’s departure date/time from the port |
CutOff | DateTime | The last date that the cargo can be delivered to the port in order to be loaded on board of the vessel |