/v1/cp-warranty.json

GET

/v1/cp-warranty.json

Post Voyage CP Warranty Data Specification

• Data Area: Global
• Output Format: JSON / JSONP
• Data Size: ~4 KB
• No Data Value: Empty string ("")

Field definitions

Field Name	Description	Unit/Format	Type
ship_name	Ship name	-	String
imo_num	IMO number	-	String
voy_num	Voyage number	-	String
loading_condition	Loading condition	-	String
eco_speed	Economical speed	-	String
seg	Segment	-	String
dep_port	Departure port	-	String
atd	Actual time of departure	-	String
arr_port	Arrival port	-	String
ata	Actual time of arrival	-	String
loss_saving.time	Loss saving time	hours	String
loss_saving.fo	Loss saving fuel oil	MT/LT	String
loss_saving.do	Loss saving diesel oil	MT/LT	String
loss_saving.fuel_unit	Loss saving fuel unit	MT/LT	String
is_warranted	Warranted flag	-	String
comment.red	Red comment	-	String
comment.yellow	Yellow comment	-	String
comment.blue	Blue comment	-	String
outside_eca.goodwx_dist	Good weather distance outside ECA	NM	String
outside_eca.goodwx_time	Good weather time outside ECA	hours	String
outside_eca.goodwx_avg_speed	Good weather average speed outside ECA	knots	String
outside_eca.goodwx_current	Good weather current outside ECA	knots	String
outside_eca.goodwx_perf_speed	Good weather performance speed outside ECA	knots	String
outside_eca.goodwx_total_fo	Good weather total fuel oil outside ECA	MT	String
outside_eca.goodwx_total_do	Good weather total diesel oil outside ECA	MT	String
outside_eca.goodwx_daily_fo	Good weather daily fuel oil outside ECA	MT/day	String
outside_eca.goodwx_daily_do	Good weather daily diesel oil outside ECA	MT/day	String
outside_eca.entire_dist	Entire distance outside ECA	NM	String
outside_eca.entire_time	Entire time outside ECA	hours	String
outside_eca.entire_avg_speed	Entire average speed outside ECA	knots	String
outside_eca.entire_current	Entire current outside ECA	knots	String
outside_eca.entire_perf_speed	Entire performance speed outside ECA	knots	String
outside_eca.entire_total_fo	Entire total fuel oil outside ECA	MT	String
outside_eca.entire_total_do	Entire total diesel oil outside ECA	MT	String
outside_eca.entire_daily_fo	Entire daily fuel oil outside ECA	MT/day	String
outside_eca.entire_daily_do	Entire daily diesel oil outside ECA	MT/day	String
inside_eca.goodwx_dist	Good weather distance inside ECA	NM	String
inside_eca.goodwx_time	Good weather time inside ECA	hours	String
inside_eca.goodwx_avg_speed	Good weather average speed inside ECA	knots	String
inside_eca.goodwx_current	Good weather current inside ECA	knots	String
inside_eca.goodwx_perf_speed	Good weather performance speed inside ECA	knots	String
inside_eca.goodwx_total_fo	Good weather total fuel oil inside ECA	MT	String
inside_eca.goodwx_total_do	Good weather total diesel oil inside ECA	MT	String
inside_eca.goodwx_daily_fo	Good weather daily fuel oil inside ECA	MT/day	String
inside_eca.goodwx_daily_do	Good weather daily diesel oil inside ECA	MT/day	String
inside_eca.entire_dist	Entire distance inside ECA	NM	String
inside_eca.entire_time	Entire time inside ECA	hours	String
inside_eca.entire_avg_speed	Entire average speed inside ECA	knots	String
inside_eca.entire_current	Entire current inside ECA	knots	String
inside_eca.entire_perf_speed	Entire performance speed inside ECA	knots	String
inside_eca.entire_total_fo	Entire total fuel oil inside ECA	MT	String
inside_eca.entire_total_do	Entire total diesel oil inside ECA	MT	String
inside_eca.entire_daily_fo	Entire daily fuel oil inside ECA	MT/day	String
inside_eca.entire_daily_do	Entire daily diesel oil inside ECA	MT/day	String
goodwx_definition.goodwx_wind	Good weather definition: wind	knots	String
goodwx_definition.goodwx_bf	Good weather definition: wind beaufort	beaufort	String
goodwx_definition.goodwx_windspeed	Good weather definition: wind speed	knots	String
goodwx_definition.goodwx_dss	Good weather definition: DSS scale	-	String
goodwx_definition.goodwx_sigwave	Good weather definition: significant wave	meter	String
goodwx_definition.goodwx_windsea	Good weather definition: windsea	meter	String
goodwx_definition.gooodwx_swell	Good weather definition: swell	meter	String
goodwx_definition.goodwx_current	Good weather definition: current	knots	String
warranted.speed	Warranted speed	knots	String
warranted.fo	Warranted fuel oil	MT	String
warranted.do	Warranted diesel oil	MT	String
allowance.speed	Allowance speed	knots	String
allowance.fo	Allowance fuel oil	MT	String
allowance.do	Allowance diesel oil	MT	String
allowance.speed_unit	Allowance speed unit	knots/%	String
allowance.fuel_unit	Allowance fuel unit	%/tons	String
rpm	Machine RPM	-	String
slip	Slip	%	String
co2_fo	CO2 from fuel oil	MT	String
co2_do	CO2 from diesel oil	MT	String
id	Identity flag	-	String

Parameters

Query Parameters

ships

Ship list (Optional). List of vessel IMO numbers separated by comma (,).
Example: 11111,22222,33333
Maximum is 20 IMO numbers per request.
If omitted, download all vessel data.

Typestring

last_x_months

Data period (Optional). Defined last "x" month data period.
Maximum period is last 48 months.
If this parameter is filled, start_time and end_time should be omitted.

Typeinteger

minimum1

maximum48

start_time

Data period (Optional). Defined start date of data period.
Date format: yyyymmdd
Maximum period is 4 years (with end_time).
If omitted, will set data period to last 4 years from end_time.
If this parameter is filled, last_x_months should be omitted.

Typestring

pattern^\d{8}$

end_time

Data period (Optional). Defined end date of data period.
Date format: yyyymmdd
Maximum period is 4 years (with start_time).
If omitted, will set data period to 4 years from start_time.
If this parameter is filled, last_x_months should be omitted.

Typestring

pattern^\d{8}$

callback

Callback function (Optional). If not set, returns JSON. If set, returns JSONP.

Typestring

Responses

Successful response with post voyage CP warranty data

Content-Type

application/json

[

{

"ship_name": "string",

"imo_num": "string",

"voy_num": "string",

"loading_condition": "string",

"eco_speed": "string",

"seg": "string",

"dep_port": "string",

"atd": "string",

"arr_port": "string",

"ata": "string",

"loss_saving": {

"time": "string",

"fo": "string",

"do": "string",

"fuel_unit": "string"

},

"is_warranted": "string",

"comment": {

"red": "string",

"yellow": "string",

"blue": "string"

},

"outside_eca": {

"goodwx_dist": "string",

"goodwx_time": "string",

"goodwx_avg_speed": "string",

"goodwx_current": "string",

"goodwx_perf_speed": "string",

"goodwx_total_fo": "string",

"goodwx_total_do": "string",

"goodwx_daily_fo": "string",

"goodwx_daily_do": "string",

"entire_dist": "string",

"entire_time": "string",

"entire_avg_speed": "string",

"entire_current": "string",

"entire_perf_speed": "string",

"entire_total_fo": "string",

"entire_total_do": "string",

"entire_daily_fo": "string",

"entire_daily_do": "string"

},

"inside_eca": {

"goodwx_dist": "string",

"goodwx_time": "string",

"goodwx_avg_speed": "string",

"goodwx_current": "string",

"goodwx_perf_speed": "string",

"goodwx_total_fo": "string",

"goodwx_total_do": "string",

"goodwx_daily_fo": "string",

"goodwx_daily_do": "string",

"entire_dist": "string",

"entire_time": "string",

"entire_avg_speed": "string",

"entire_current": "string",

"entire_perf_speed": "string",

"entire_total_fo": "string",

"entire_total_do": "string",

"entire_daily_fo": "string",

"entire_daily_do": "string"

},

"goodwx_definition": {

"goodwx_wind": "string",

"goodwx_bf": "string",

"goodwx_windspeed": "string",

"goodwx_dss": "string",

"goodwx_sigwave": "string",

"goodwx_windsea": "string",

"gooodwx_swell": "string",

"goodwx_current": "string"

},

"warranted": {

"speed": "string",

"fo": "string",

"do": "string"

},

"allowance": {

"speed": "string",

"fo": "string",

"do": "string",

"speed_unit": "string",

"fuel_unit": "string"

},

"rpm": "string",

"slip": "string",

"co2_fo": "string",

"co2_do": "string",

"id": "string"

}

]

GET

/v1/cp-warranty.json

Playground

Authorization

Authorization

Variables

Key

Value

ships

last_x_months

start_time

end_time

callback

Samples