Dark Mode
/v1/enroute-cp-warranty.json
GET
/v1/enroute-cp-warranty.json
EnRoute 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 | Sample Value | Type |
|---|---|---|---|---|
| ship_name | Ship name | - | Ship A | String |
| imo_num | IMO number | - | 1010101 | String |
| voy_num | Voyage number | - | 123A | String |
| loading_condition | Loading condition | - | L | String |
| cp_warranty | CP warranty data | Hash | String | |
| analyzed_time | Analysis creation time (MMM-dd/yyyy hh:ss UTC) | - | Feb-24/2020 04:06 UTC | String |
| def_goodwx | Good weather definition | - | BF 4, Sig. Wave 1.25m (DSS3), No adverse Current | String |
| allwx_avg_speed | All weather average speed | knots | 11.91 | String |
| allwx_perf_speed | All weather performance speed | knots | 12.23 | String |
| allwx_distance | All weather distance | NM | 2850 | String |
| allwx_time | All weather time | hour | 239.2 | String |
| allwx_cf | All weather current factor | knots | -0.22 | String |
| allwx_daily_fo | All weather daily fuel oil | MT | 18.99 | String |
| allwx_daily_dogo | All weather daily diesel/gas oil | MT | 0.1 | String |
| allwx_total_fo | All weather total fuel oil | MT | 189.22 | String |
| allwx_total_dogo | All weather total diesel/gas oil | MT | 1 | String |
| goodwx_avg_speed | Good weather average speed | knots | 12.46 | String |
| goodwx_perf_speed | Good weather performance speed | knots | 12.15 | String |
| goodwx_distance | Good weather distance | NM | 617 | String |
| goodwx_time | Good weather time | hour | 49.5 | String |
| goodwx_sigwave | Good weather definition of significant wave height | meter | 1.25 | String |
| goodwx_cf | Good weather current factor | knots | 0.31 | String |
| goodwx_bf | Good weather definition of wind beaufort | beaufort | 4 | String |
| goodwx_current | Good weather definition of ocean current | - | No adverse Current | String |
| goodwx_daily_fo | Good weather daily fuel oil | MT | 18.98 | String |
| goodwx_daily_dogo | Good weather daily diesel/gas oil | MT | 0.1 | String |
| goodwx_total_fo | Good weather total fuel oil | MT | 39.15 | String |
| goodwx_total_dogo | Good weather total diesel/gas oil | MT | 0.2 | String |
| cp_speed | CP warranty speed | knots | 11.5 | String |
| cp_fo | CP warranty fuel oil | MT | 20.5 | String |
| cp_dogo | CP warranty diesel/gas oil | MT | 0.1 | String |
| cp_fuel_unit | CP warranty fuel unit | - | MT | String |
| allow_speed | Allowance speed | knots | 0.5 | String |
| allow_speed_unit | Allowance speed unit | - | kts | String |
| allow_fo | Allowance fuel oil | % | 5 | String |
| allow_dogo | Allowance diesel/gas oil | % | 5 | String |
| allow_fuel_unit | Allowance fuel unit | - | % | String |
| saving_time | Loss or saving time value ("-"=Saving, "+"=Loss) | Hours | 1.3 | String |
| saving_time_unit | Loss or saving time unit | - | hrs | String |
| saving_fo | Fuel oil over/under-consumption value ("-"=Saving, "+"=Loss) | MT | -24.78 | String |
| saving_fuel_unit | Fuel oil over/under-consumption unit | - | MT | String |
| saving_dogo | DO/GO over/under-consumption value ("-"=Saving, "+"=Loss) | MT | -0.13 | String |
| damage_info_speed | Time loss or saving information (time lost / no time lost / "") | - | time lost | String |
| damage_info_fo | Fuel oil over/under-consumption information (over consumption / saving / "") | - | saving | String |
| damage_info_dogo | DO/GO over/under-consumption information (over consumption / saving / "") | - | saving | String |
| comment | Comment/remarks | - | Loss or saving calculated may not represent correct assessment because the good weather period is 50 hours or less. | String |
Parameters
Query Parameters
ships
Ship list (Optional). List of vessel IMO numbers separated by comma (,).
Example: 11111,22222,33333
Maximum is 50 IMO numbers per request.
If omitted, returns all ships.
Typestring
callback
Callback function (Optional). If not set, returns JSON. If set, returns JSONP.
Typestring
Responses
Successful response with enroute CP warranty data
application/json
JSON
[
{
"ship_name": "string",
"imo_num": "string",
"voy_num": "string",
"loading_condition": "string",
"cp_warranty": {
"analyzed_time": "Feb-24/2020 04:06 UTC",
"def_goodwx": "BF 4, Sig. Wave 1.25m (DSS3), No adverse Current",
"allwx_avg_speed": "string",
"allwx_perf_speed": "string",
"allwx_distance": "string",
"allwx_time": "string",
"allwx_cf": "string",
"allwx_daily_fo": "string",
"allwx_daily_dogo": "string",
"allwx_total_fo": "string",
"allwx_total_dogo": "string",
"goodwx_avg_speed": "string",
"goodwx_perf_speed": "string",
"goodwx_distance": "string",
"goodwx_time": "string",
"goodwx_sigwave": "string",
"goodwx_cf": "string",
"goodwx_bf": "string",
"goodwx_current": "string",
"goodwx_daily_fo": "string",
"goodwx_daily_dogo": "string",
"goodwx_total_fo": "string",
"goodwx_total_dogo": "string",
"cp_speed": "string",
"cp_fo": "string",
"cp_dogo": "string",
"cp_fuel_unit": "string",
"allow_speed": "string",
"allow_speed_unit": "string",
"allow_fo": "string",
"allow_dogo": "string",
"allow_fuel_unit": "string",
"saving_time": "string",
"saving_time_unit": "string",
"saving_fo": "string",
"saving_fuel_unit": "string",
"saving_dogo": "string",
"damage_info_speed": "string",
"damage_info_fo": "string",
"damage_info_dogo": "string",
"comment": "string"
}
}
]