/v2.1/voyage.json

GET

/v2.1/voyage.json

Voyage Track Data Output Specifications

No	Item Name	Full Name	Unit/Format	Values Type
1	shipInfo	Vessel information data	Hash Key	-
2	imoNum	Vessel IMO number	IMO number format	string
3	shipName	Vessel name	Maritime call sign format	string
4	callsign	Vessel call sign code	-	string
5	shipType	Vessel type (CONTAINER, PCTC, DRY BULKER, TANKER)	-	string
6	mcr	MCR (Maximum Continuous Rating)	-	string
7	nor	NOR (Notice of Readiness)	-	string
8	summerdraft	Maximum setting in summer	Meter	string
9	voyageInfo	Voyage information data	Hash Key	-
10	departureInfo	Departure information data	Hash Key	-
11	arrivalInfo	Arrival information data	Hash Key	-
12	portName	Port name	-	string
13	portCode	Port code	-	string
14	reportedInfo	Master report information data	Hash Key	-
15	route	Vessel route data; Contains summary for each vessel route	Hash Key	-
16	routeInfo	Vessel route information data	Hash Key	-
17	routeType	Vessel route type (Actual, Recommended)	Hash Key	-
18	calculateETA	Calculated ETA	Date (yyyy/mm/ddThh:mm)	string
19	purpose	If recommended route, then "Recommended"	-	string
20	summary	Vessel route summary; Contains point track info	Hash Key	-
21	deadreckinigPointInfo	Dead reckoning point information data	Hash Key	-
22	point	Point track data	Hash Key (Array in Hash)	-
23	sourceId	Source of point data from master report	r1 is "report 1st"	string
24	pointType	Type of point data	SOSP, NOON, EOSP, Reported	string
25	dateTime	Date and time of point data	Date (yyyy/mm/ddThh:mm:ss)	string
26	lat	latitude information	Minute	string
27	lon	longitude information	Minute	string
28	navTrack	Distance Measure : Rhumb line or Great Circle	GC, RL	string
29	setRpm	Setting RPM in the point	rpm	string
30	averageRpm	Average RPM until the point	rpm	string
31	speed	Speed of vessel in the point	m/s	string
32	slip	Slip of vessel in the point	-	string
33	goodWeatherSpeed	Speed on good weather condition (simulation)	knots	string
34	heading	Heading of vessel in the point	Degree	string
35	setLoad	Loading condition of vessel in the point	-	string
36	fuel	High/Low sulfur fuel oil info	Hash Key	-
37	diesel	Diesel fuel information	Hash Key	-
38	gas	Gas fuel information	Hash Key	-
39	ultraLowsulfur	Ultra low sulfur fuel oil info	Hash Key	-
40	remainOnBoard	Remaining fuel from each fuel type	Hash Key	-
41	mainEngineConsumption	Fuel consumption of main engine	Hash Key	-
42	auxiliaryEngineConsumption	Fuel consumption of auxiliary engine	Hash Key	-
43	generatorConsumption	Fuel consumption of generator	Hash Key	-
44	boilerConsumption	Fuel consumption of boiler	Hash Key	-
45	otherConsupmtion	Another use/consumption of fuel	Hash Key	-
46	highSulfur	High sulfur oil info from each type	-	string
47	lowSulfur	Low sulfur oil info from each type	-	string
48	total	Combination between high/low sulfur	-	string
49	weather	Weather information data	Hash Key	-
50	significantWaveHeight	Significant wave height	Meter	string
51	primaryWaveHeight	Primary wave height	Meter	string
52	primaryWaveDirection	Primary wave direction (Coming From)	Decimal	string
53	primaryWavePeriod	Primary wave period	Second	string
54	secondlyWaveHeight	Secondly wave height	Meter	string
55	secondlyWaveDirection	Secondly wave direction (Coming From)	Decimal	string
56	secondlyWavePeriod	Secondly wave period	Second	string
57	swellWaveHeight	Swell wave height	Meter	string
58	swellWaveDirection	Swell wave direction (Coming From)	Decimal	string
59	swellWavePeriod	Swell wave period	Second	string
60	windSeaWaveHeight	Wind sea wave height	Meter	string
61	windSeaWaveDirection	Wind sea wave direction (Coming From)	Decimal	string
62	windSeaWavePeriod	Wind sea wave period	Second	string
63	currentU	Ocean current u-component	Vector	string
64	currentV	Ocean current v-component	Vector	string
65	currentSpd	Ocean current speed	Knots	string
66	currentDir	Ocean current direction (Going to)	Degree	string
67	windU	Wind u-component	Vector	string
68	windV	Wind v-component	Vector	string
69	windSpd	Wind speed	Knots	string
70	windSpdBF	Wind speed beaufort	Beaufort	string
71	windDir	Wind direction (Going to)	Degree	string
72	currentFactor	Current Factor	Probability	string
73	weatherFactor	Weather Factor	Knots	string
74	distanceDR	Distance from the previous DR point	NM	string
75	foDRConsumption	Fuel consumption on the specific DR point	MT	string
76	foConsumption	Daily normalised consumption since previous pos	MT	string
77	secaCode	SECA area code	See below	string
78	draftInfo	Vessel draft information on voyage	Hash Key	-
79	draftFore	Fore draft	Meter	string
80	draftMid	Middle draft	Meter	string
81	draftAft	Aft draft	Meter	string
82	voyagePriority	Voyage Priority	-	string
83	instractedSpeed	Vessel instructed speed	Knots	string
84	vpsheetSendTime	Voyage planning sheet sending time	Date (yyyy/mm/ddThh:mm:ss)	string

SECA area code

Code	Area
0	Outside SECA
1	Europe
2	Hawaii
3	North America
4	Puerto Rico
5	Caribbean
6	Green Flag(40nm)
7	Green Flag
8	Yangtze
9	China Coast

Parameters

Query Parameters

imo*

IMO number of the ship

Typestring

Required

report*

Voyage Report Type

a : Master/Captain report only
b : Master/Captain report with DRPoint (without weather information)
c : Master/Captain report with DRPoint (with weather information)
d : Future point (voyage plan, including DRPoint) start from the latest Master report (without weather information)
e : Future point (voyage plan, including DRPoint) start from the latest Master report (with weather information)
f : Master/Captain report + Voyage Plan (without weather information)
g :Master/Captain report + Voyage Plan (with weather information)
h :Voyage Plan without weather information
i :Voyage Plan with weather information

Typestring

Required

Enum

abcdefghi

start

Start Date of Voyage
Format: yyyymmddhh
If the start and end parameter are filled: Get 10 latest voyage between the start date and end date of the voyage
If start parameter only is filled: Get 10 latest voyage from the start date to the latest voyage of the vessel
If the start and end parameter are omitted: Directed to the lastest voyage data

Typestring

end

End Date of Voyage
Format: yyyymmddhh
If the start and end parameter are filled: Get 10 latest voyage between the start date and end date of the voyage
If end parameter only is filled: Get 10 latest voyage from end date (end date to be start date) to the latest voyage of the vessel
If the start and end parameter are omitted: Directed to the lastest voyage data

Typestring

version

Voyage Data Type
vpsheet: Return voyage data that is the same with WNI voyage planning sheet latest version. (default)
published: Return WNI officially released voyage data.

Typestring

Enum

vpsheetpublished

Responses

Successful response with voyage data

Content-Type

application/json

JSON

{

"vpsSendTime": "string",

"shipInfo": {

"imoNum": "string",

"shipName": "string",

"callsign": "string",

"shipType": "string",

"mcr": "string",

"nor": "string",

"summerdraft": "string"

"voyageInfo": {

"voyagePriority": "string",

"departureInfo": {

"portName": "string",

"portCode": "string",

"point": {

"lat": "string",

"lon": "string"

}

"arrivalInfo": {

"portName": "string",

"portCode": "string",

"point": {

"lat": "string",

"lon": "string"

}

"draftInfo": {

"draftFore": "string",

"draftMid": "string",

"draftAft": "string"

"instractedSpeed": "string",

"reportedInfo": {

"point": [

{

"sourceId": "string",

"pointType": "string",

"dateTime": "string",

"point": {

"lat": "string",

"lon": "string"

"navTrack": "string",

"setRpm": "string",

"averageRpm": "string",

"speed": "string",

"slip": "string",

"averageMainengineLoad": "string",

"heading": "string",

"fuel": {

"remainOnBoard": {