Passage Plans

Import Passage Plan

Import a passage plan for one of your managed vessels.

Notes

Passage plans can only be imported for vessels that belong to user's managed vessels (see Fleet Operations solution for more info)
Accepted file formats are CSV, RTZ or RT3
Maximum file size supported is 20MB
File should contain at least 2 waypoints
Imported passage plans overwrite previously imported ones for the provided api_key and IMO combination
The frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.
Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.

api_key

required

string

API key: 40-character hexadecimal number

Content-Type

required

string

Default: multipart/form-data

Request's Content-Type

Array ()

imo	integer The International Maritime Organization (IMO) number of the vessel you wish to import the passage plan for
file	object Input file that contains an ECDIS passage plan. Accepted formats are: CSV, RTZ and RT3
protocol	string Response type. Use one of the following: xml, csv, json, jsono (object)

Content type

application/json

[{"imo": 9750701,
"file": "your_file.rtz",
"suez": "jsono"
}
]

Content type

{"status": [{"code": "s8",
"description": "PASSAGE PLAN IMPORTED"
}
]
}