API Version: v1.0
Overview
The Get Sailing schedule Rotation API allows you to get up-to-date schedules with full rotation of voyage for vessels for a specific line.
Sample Request
HTTP
GET https://app.logisoft.io/api/voyage/rotation
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | Successful operation |
Parameters
Name | Required | Type | Description |
---|---|---|---|
ScheduleCategory | false | string | Trade routes e.g. USA, Europe, etc. |
PolContinent | false | Enum | The continent where the Pols are located. |
Pol | false | string | The name of the port of loading |
Pod | false | 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 the ports of discharge |
ArrivalMax | false | DateTime | Maximum arrival date/time to the ports of discharge |
DepartureMin | false | DateTime | Minimum departure date/time from the ports of loading |
DepartureMax | false | DateTime | Maximum departure date/time from the ports of loading |
Line | false | string | The name of the Shipping Line |
PodRegion | false | Enum | The region where the Pods are located |
Sample Response
Status code: 200
JSON
{ "ports": [ { "name": "Zárate", "country": "Argentina", "continent": 7 }, { "name": "Savannah", "country": "United States of America", "continent": 6 }, { "name": "Wilmington, DE", "country": "United States of America", "continent": 6 }, ], "voyages": [ { "voyage": "GCG0819", "vessel": "Grande Congo", "maxUnitHeight": null, "maxUnitWidth": null, "maxUnitWeight": null, "visits": [ { "port": "Jacksonville", "terminal": "GRM-USJAX", "arrival": "2019-11-21T00:10:00", "departure": "2019-11-21T00:10:00", "cutOff": null, "canLoad": true, "canDischarge": false }, { "port": "Savannah", "terminal": "GRM-USSAV", "arrival": "2019-11-21T17:12:24", "departure": "2019-11-22T07:07:36", "cutOff": null, "canLoad": true, "canDischarge": true }, { "port": "Baltimore", "terminal": "GRM-USBAL", "arrival": "2019-11-24T05:55:36", "departure": "2019-11-25T05:12:24", "cutOff": null, "canLoad": true, "canDischarge": true } ] }, { "voyage": "MRE0119", "vessel": "MERMAID ACE", "maxUnitHeight": null, "maxUnitWidth": null, "maxUnitWeight": null, "visits": [ { "port": "Baltimore", "terminal": "GRM-USBAL", "arrival": "2019-11-28T12:10:00", "departure": "2019-11-28T12:10:00", "cutOff": null, "canLoad": true, "canDischarge": false }, { "port": "Wilmington, DE", "terminal": "GRM-USDEL", "arrival": "2019-11-29T03:17:12", "departure": "2019-11-29T21:02:48", "cutOff": null, "canLoad": true, "canDischarge": true } ] } ] }
Properties
Response:
Name | Type | Description |
---|---|---|
Ports | SchedulePort[] | The SchedulePort list |
Voyages | ScheduleVoyage[] | The ScheduleVoyage list |
SchedulePort:
Name | Type | Description |
---|---|---|
Name | string | Shipping Line name |
Country | string | Country name |
Continent | Continent | Continent name |
ScheduleVoyage:
Name | Type | Description |
---|---|---|
Voyage | string | The voyage number |
Vessel | string | Vessel name |
MaxUnitHeight | decimal | Maximum unit height |
MaxUnitWidth | decimal | Maximum unit width |
MaxUnitWeight | decimal | Maximum unit weight |
Visits | ScheduleVisit[] | The ScheduleVisit list |
ScheduleVisit:
Name | Type | Description |
---|---|---|
PortId | int | The Id of the port |
Port | string | The port’s name |
Terminal | string | The terminal’s name |
Arrival | DateTime | The arrival date/time to ports of discharge |
Departure | DateTime | The departure date/time from ports of loading |
CutOff | DateTime | The last date that the cargo can be delivered to the port in order to be loaded on board of the vessel |
CanLoad | bool | whether the vessel is able to load |
CanDischarge | bool | Whether the vessel is able to discharge |