Provides, for a required specific service and/or voyage and/or vessel and/or location, the timetable of estimated departure and arrival times for each port call on the rotation of the vessel(s).<br/>The list of schedules returned in the response can be tailored to specific needs by combining available query parameters.<br/>Examples of typical query parameters and expected payload returned in the response:<br/><ul> <li>a) carrierServiceCode: Get all vessels and their full voyages within a service</li><li>b) carrierServiceCode & carrierVoyageNumber: Get a specific full voyage within a service</li><li>c) carrierServiceCode & vesselIMONumber: Get a specific vessel’s full voyages within a service.</li><li>d) vesselIMONumber: Get all full voyages for a specific vessel across all the services in which it is involved.</li><li>e) UNLocationCode: Get all vessels and their full voyages where the specific UNLocationCode is involved</li><li>f) UNLocationCode & facilitySMDGCode: Get all vessels and their full voyages where the specific UNLocationCode and facilitySMDGCode is involved</li></ul> Other combinations using vesselName, universalServiceReference, universalVoyageReference, vesselOperatorCarrierCode, startDate, endDate are possible.<br/>The resulting payload returned in the responses will always include entire voyage(s) being matched. This means that even though a filter only matches a single Port (UNLocationCode) in a Voyage or a single Timestamp within a Port in a Voyage - the entire Voyage matched is returned. If the carrierImportVoyageNumber of the Port differs from the carrierExportVoyageNumber of the Port then the entire Voyage for both these Voyage numbers are included. An example of this is when &UNLocationCode=DEHAM is used as a filter parameter. In this case entire Voyages would be listed where DEHAM is a Port.<br/>Be aware that it is possible to specify filters that are mutually exclusive resulting in an empty response list. An example of this could be when both using vesselIMONumber and vesselName filters at the same time: &vesselIMONumber=9321483&vesselName=King of the Seas. If no Vessel exists where vesselIMONumber is 9321483 and vesselName is King of the Seas then the result will be an empty list.<br/>If no startDate filter is provided, then 3 months before the request date should be used as default. If no endDate filter is provided, then 6 months after the request date should be used as default. The endpoint provider can customize these based on their business definitions and inform the consumers what to expect in a response when these filters are not used.<br/>The GET /v1/vessel-schedules endpoint can be implemented independently of having implemented the GET /v1/point-to-point-routes and GET /v1/port-schedules endpoints.<br/><b>IMPORTANT</b>: This endpoint is for carriers to make available vessel schedules to BCO, LSP, and Solution Platforms, with a commercial purpose; this is out of the boundaries of their vessel schedules alignment with other carriers and terminals for operational purposes for which the Operational Vessel Schedules API is used between carriers, and carriers and terminals.<br/>
The name of a vessel. The result will only return schedules including the vessel with the specified name. Be aware that the vesselName is not unique and might match multiple vessels.<br/>
Carrier Service Code
Private
String(11)
Notes:
The carrier specific service code to filter by. The result will only return schedules including the service code.<br/>
Universal Service Reference
Private
String(8)
Notes:
The Universal Service Reference (USR) as defined by DCSA to filter by.<br/><i>pattern: ^SR\d{5}[A-Z]$</i><br/><i>maxLength: 8</i><br/><i>minLength: 8</i><br/>
Carrier Voyage Number
Private
String(50)
Notes:
The carrier specific identifier of a Voyage - can be both importVoyageNumber and exportVoyageNumber. The result will only return schedules including the Ports where carrierVoyageNumber is either carrierImportVoyageNumber or carrierExportVoyageNumber.<br/>
Universal Voyage Reference
Private
String(5)
Notes:
The Universal Reference of a Voyage - can be both importUniversalVoyageReference and exportUniversalVoyageReference. The result will only return schedules including the Ports where universalVoyageReference is either importUniversalVoyageReference or exportUniversalVoyageReference.<br/>
UN Location Code (better Port Location)
Private
String(5)
Notes:
The UN Location Code specifying where a port is located. Specifying this filter will only return schedules including entire Voyages related to this particular UN Location Code.<br/><i>pattern: ^[A-Z]{2}[A-Z2-9]{3}$</i><br/><i>minLength: 5</i><br/><i>maxLength: 5</i><br/>
Facility SMDG Code
Private
String(6)
Notes:
The facilitySMDGCode specifying a specific facility (using SMDG Code). Be aware that the facilitySMDGCode does not contain a UNLocationCode - this must be specified in the UNLocationCode filter. Specifying this filter will only return schedules including entire Voyages related to this particular facilitySMDGCode.<br/>
Vessel Operator Carrier Code
Private
String(10)
Notes:
The carrier who is in charge of the vessel operation based on either the SMDG or SCAC code lists.<br/>
Start Date
Private
Date
Notes:
The start date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a PortCall matches a date on or after (≥) the startDate the entire Voyage (import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call. <br/>If this filter is not provided the default value is 3 months prior to request time. The value is populated in ISO 8601 date format.<br/>
End Date
Private
Date
Notes:
string($date)<br/>(query)<br/> <br/><br/>The end date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a PortCall matches a date on or before (≤) the endDate the entire Voyage(import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call.<br/>If this filter is not provided the default value is 6 months after request time. The value is populated in ISO 8601 date format.<br/>
Limit
Private
int
Notes:
Maximum number of items to return.<br/><i>Default value : 100</i><br/>
Cursor
Private
String(1024)
Notes:
A server generated value to specify a specific point in a collection result, used for pagination.<br/>
