NxtPort PortVoyages API
Version: 1.0
Base URLs
-
< https://api-portvoyages.nxtport.com/v1> — PRD Environment
Endpoints
getPortVoyages
GET /voyages
PortVoyages API
Parameters
|
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
|
query |
|
yes |
Referentiedatum die bepaalt welke data moet worden opgehaald: op basis van deze date/time gaat systeem enkel gewijzigde reisdata ophalen vanaf het opgegeven moment. Je kan tot max 6 uur terug. Formaat is "yyyy-MM-ddThh:mm:ssZ". |
Responses
|
Status |
Description |
Content type |
|---|---|---|
|
|
A valid response |
application/json |
|
|
Forbidden |
— |
|
|
Too many requests |
— |
|
|
Unexpected Problem |
application/json |
Data models
PortVoyageShipResponseDTO
JSON
{
"type": "object",
"properties": {
"ship_name": {
"type": "string",
"description": "Naam schip"
},
"imo_number": {
"type": "string",
"description": "IMO nummer"
},
"mmsi_number": {
"type": "string",
"description": "MMSI nummer"
},
"call_sign": {
"type": "string",
"description": "Callsign"
},
"flag_code": {
"type": "string",
"description": "Vlag"
},
"ship_type": {
"type": "string",
"description": "Scheepstype"
},
"gross_tonnage": {
"type": "integer",
"description": "Bruto tonnenmaat",
"format": "int64"
}
}
}
PtaResponseDTO
JSON
{
"type": "object",
"properties": {
"location": {
"type": "string"
},
"pt": {
"type": "string",
"format": "date-time"
}
}
}
LockResponseDTO
JSON
{
"type": "object",
"properties": {
"lock_code": {
"type": "string"
},
"direction": {
"type": "string"
}
}
}
TravelPlanResponseDTO
JSON
{
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"time_type": {
"type": "string"
},
"location": {
"type": "string"
},
"location_name": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
PortVoyagePersonsOnBoardResponseDTO
JSON
{
"type": "object",
"properties": {
"name_captain": {
"type": "string",
"description": "Naam capitein"
},
"crew_members_count": {
"type": "integer",
"description": "Aantal crewmembers aan boord",
"format": "int32"
},
"passengers_count": {
"type": "integer",
"description": "Aantal passagiers aan boord",
"format": "int32"
},
"sent": {
"type": "boolean",
"description": "bericht verstuurt"
}
}
}
PortVoyageResponseDTO
JSON
{
"type": "object",
"properties": {
"voyage_number": {
"type": "string",
"description": "Reisnummer"
},
"stay_number": {
"type": "string",
"description": "Verblijfsnummer"
},
"sequence_in_stay": {
"type": "integer",
"description": "Volgordenummer van de reis binnen het verblijf",
"format": "int32"
},
"operational_length": {
"type": "number",
"description": "Lengte over alles",
"format": "double"
},
"operational_breadth": {
"type": "number",
"description": "Grootste breedte",
"format": "double"
},
"operational_draught_bow": {
"type": "number",
"description": "Operationele diepgang voor",
"format": "double"
},
"operational_draught_stern": {
"type": "number",
"description": "Operationele diepgang achter",
"format": "double"
},
"agent": {
"type": "string",
"description": "Scheepsagent"
},
"agent_name": {
"type": "string",
"description": "Naam scheepsagent"
},
"previous_port_of_call": {
"type": "string",
"description": "Vorige aanloophaven"
},
"previous_port_of_call_name": {
"type": "string",
"description": "Vorige aanloophaven naam"
},
"next_port_of_call": {
"type": "string",
"description": "Volgende aanloophaven"
},
"next_port_of_call_name": {
"type": "string",
"description": "Volgende aanloophaven naam"
},
"port_of_origin": {
"type": "string",
"description": "Haven herkomst"
},
"port_of_origin_name": {
"type": "string",
"description": "Haven herkomst naam"
},
"port_of_destination": {
"type": "string",
"description": "Haven bestemming"
},
"port_of_destination_name": {
"type": "string",
"description": "Haven bestemming naam"
},
"cbs_entry_point": {
"type": "string",
"description": "CBS Entrypoint"
},
"cbs_entry_point_name": {
"type": "string",
"description": "CBS Entrypoint naam"
},
"cbs_entry_point_eta": {
"type": "string",
"description": "ETA CBS Entrypoint",
"format": "date-time"
},
"cbs_exit_point": {
"type": "string",
"description": "CBS Exitpoint"
},
"cbs_exit_point_name": {
"type": "string",
"description": "CBS Exitpoint naam"
},
"cbs_exit_point_ata": {
"type": "string",
"description": "ATA CBS Exitpoint",
"format": "date-time"
},
"stay_start": {
"type": "string",
"description": "Datum/tijd start van het verblijf in de haven",
"format": "date-time"
},
"stay_end": {
"type": "string",
"description": "Datum/tijd van het vertrek uit de haven",
"format": "date-time"
},
"voyage_start": {
"type": "string",
"description": "Datum/tijd start reis",
"format": "date-time"
},
"voyage_end": {
"type": "string",
"description": "Datum/tijd einde reis",
"format": "date-time"
},
"passage_point_eta": {
"type": "string",
"description": "Naam locatie meest recente ETA"
},
"passage_point_eta_name": {
"type": "string"
},
"eta": {
"type": "string",
"description": "Datum/tijd meest recente ETA",
"format": "date-time"
},
"passage_point_ata": {
"type": "string",
"description": "Locatie meest recente ATA"
},
"passage_point_ata_name": {
"type": "string",
"description": "Naam locatie meest recente ATA"
},
"ata": {
"type": "string",
"description": "Datum/tijd meest recente ATA",
"format": "date-time"
},
"etd": {
"type": "string",
"description": "ETD",
"format": "date-time"
},
"stay_cancelled": {
"type": "string",
"description": "Datum/tijd verblijf geannuleerd",
"format": "date-time"
},
"stay_cancelled_reason": {
"type": "string",
"description": "Redenen verblijf geannuleerd"
},
"voyage_cancelled": {
"type": "string",
"description": "Datum/tijd reis geannuleerd",
"format": "date-time"
},
"voyage_cancelled_reason": {
"type": "string",
"description": "Redenen reis geannuleerd"
},
"berth_of_origin": {
"type": "string",
"description": "Ligplaats vertrek"
},
"berth_of_origin_name": {
"type": "string",
"description": "Naam ligplaats vertrek"
},
"terminal_of_origin": {
"type": "string",
"description": "Terminal vertrek"
},
"terminal_of_origin_name": {
"type": "string",
"description": "Naam terminal vertrek"
},
"berth_of_destination_from": {
"type": "string",
"description": "Ligplaats bestemming van"
},
"berth_of_destination_from_name": {
"type": "string",
"description": "Naam ligplaats bestemming van"
},
"berth_of_destination_to": {
"type": "string",
"description": "Ligplaats bestemming tot"
},
"berth_of_destination_to_name": {
"type": "string",
"description": "naam_ligplaats bestemming tot"
},
"terminal_of_destination": {
"type": "string",
"description": "Terminal bestemming"
},
"terminal_of_destination_name": {
"type": "string",
"description": "Naam terminal bestemming"
},
"mooring_side": {
"type": "string",
"description": "Meerzijde"
},
"mooring_position": {
"type": "string",
"description": "Meerpositie"
},
"route_category": {
"type": "string",
"description": "Soort reis"
},
"voyage_state": {
"type": "string",
"description": "Status reis"
},
"incoming_mode": {
"type": "string",
"description": "Opvaarttype"
},
"ship": {
"description": "Schip",
"$ref": "#/components/schemas/PortVoyageShipResponseDTO"
},
"persons_on_board": {
"$ref": "#/components/schemas/PortVoyagePersonsOnBoardResponseDTO"
},
"pts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PtaResponseDTO"
}
},
"locks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LockResponseDTO"
}
},
"travel_plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TravelPlanResponseDTO"
}
}
}
}
PortStayShipResponseDTO
JSON
{
"type": "object",
"properties": {
"ship_name": {
"type": "string",
"description": "Naam schip"
},
"imo_number": {
"type": "string",
"description": "IMO nummer"
},
"call_sign": {
"type": "string",
"description": "Callsign"
},
"ship_type": {
"type": "string",
"description": "Scheepstype"
}
}
}
PortStayResponseDTO
JSON
{
"type": "object",
"properties": {
"stay_number": {
"type": "string",
"description": "Verblijfsnummer"
},
"previous_port_of_call": {
"type": "string",
"description": "Vorige aanloophaven"
},
"next_port_of_call": {
"type": "string",
"description": "Volgende aanloophaven"
},
"cbs_entry_point": {
"type": "string",
"description": "CBS Entrypoint"
},
"cbs_entry_point_eta": {
"type": "string",
"description": "ETA CBS Entrypoint",
"format": "date-time"
},
"etd": {
"type": "string",
"description": "ETD",
"format": "date-time"
},
"stay_start": {
"type": "string",
"description": "Datum/tijd start van het verblijf in de haven",
"format": "date-time"
},
"stay_end": {
"type": "string",
"description": "Datum/tijd van het vertrek uit de haven",
"format": "date-time"
},
"berth_at_arrival": {
"type": "string",
"description": "Ligplaats bij aankomst"
},
"berth_at_departure": {
"type": "string",
"description": "Ligplaats bij vertrek"
},
"ship": {
"description": "Schip",
"$ref": "#/components/schemas/PortStayShipResponseDTO"
}
}
}
Problem
JSON
{
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
}
}
}
PortOfAntwerpProblem
JSON
{
"type": "object",
"properties": {
"stacktrace": {
"type": "string"
},
"message": {
"type": "string"
}
}
}