/v2/cp-warranty.json

GET

/v2/cp-warranty.json

Post Voyage CP Warranty Data (v2)

Replaces /v1/cp-warranty with a serverless backend (Lambda + DynamoDB).
Response format is v1-compatible — same flat array structure, all values are strings.

Item	Value
Format	JSON
Region	Global
Update	When Audit XML is published in SeaNavigator
Max Results	2000 segments per request (X-Truncated: true when exceeded)

Key Changes from v1

• client / section parameters removed — auto-detected from auth token
• callback (JSONP) removed — CORS supported natively
• HTTP 207 returned when some IMO numbers are not found in ShipDB
• X-Warning: SHIP_NOT_FOUND:{imo,...} header lists unresolved IMO numbers
• rpm / slip always empty string (not available in new data source)
• comment.red/yellow/blue always empty string (deprecated in SeaNavigator migration)
• last_x_months default changed from 12 to 6 months

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	Eco speed indicator (E/R/U or empty)	-	String
seg	Segment ID	-	String
dep_port	Departure port	-	String
atd	Actual time of departure (YYYYMMDDhhmm)	-	String
arr_port	Arrival port	-	String
ata	Actual time of arrival (YYYYMMDDhhmm)	-	String
loss_saving.time	Loss saving time	hours	String
loss_saving.fo	Loss saving fuel oil	MT	String
loss_saving.do	Loss saving diesel oil	MT	String
loss_saving.fuel_unit	Loss saving fuel unit (always "MT")	MT	String
is_warranted	Warranted flag (always empty in v2)	-	String
comment.red	Red comment (always empty in v2)	-	String
comment.yellow	Yellow comment (always empty in v2)	-	String
comment.blue	Blue comment (always empty in v2)	-	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 factor 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 factor 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 factor 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 factor 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 wind speed threshold	knots	String
goodwx_definition.goodwx_bf	Good weather Beaufort scale threshold	Beaufort	String
goodwx_definition.goodwx_windspeed	Good weather wind speed threshold	knots	String
goodwx_definition.goodwx_dss	Good weather Douglas Sea Scale threshold	-	String
goodwx_definition.goodwx_sigwave	Good weather significant wave height threshold	meter	String
goodwx_definition.goodwx_windsea	Good weather wind wave height threshold	meter	String
goodwx_definition.gooodwx_swell	Good weather swell height threshold (note: triple 'o')	meter	String
goodwx_definition.goodwx_current	Good weather current condition (e.g., "All")	-	String
warranted.speed	Warranted speed	knots	String
warranted.fo	Warranted fuel oil consumption	MT/day	String
warranted.do	Warranted diesel oil consumption	MT/day	String
allowance.speed	Allowance speed tolerance	knots	String
allowance.fo	Allowance fuel oil tolerance	-	String
allowance.do	Allowance diesel oil tolerance	-	String
allowance.speed_unit	Allowance speed unit	kts	String
allowance.fuel_unit	Allowance fuel unit	%	String
rpm	Engine RPM (always empty in v2)	-	String
slip	Propeller slip (always empty in v2)	-	String
id	Audit ID (SeaNavigator Audit XML ServiceID)	-	String

Parameters

Header Parameters

Authorization*

"WniWebApi " + Token ID

Typestring

Required

Query Parameters

ships*

Ship list (Required). List of vessel IMO numbers (7 digits) separated by comma (,).
Example: 9882994,9660061
Maximum 20 IMO numbers per request.
IMO numbers not found in ShipDB trigger HTTP 207 with X-Warning header.

Typestring

Required

last_x_months

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

Typeinteger

minimum1

maximum48

default6

start_time

Data period (Optional). Defined start date of data period.
Date format: YYYYMMDD
If omitted with end_time specified, defaults to 1 year before 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
If omitted with start_time specified, defaults to today.
If this parameter is filled, last_x_months should be omitted.

Typestring

pattern^\d{8}$

Responses

Successful response — all requested IMOs found

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",

"id": "string"

}

]

GET

/v2/cp-warranty.json

Playground

Headers

Authorization*

Variables

Key

Value

ships*

last_x_months

start_time

end_time

Samples