Additional Documentation

Unit Conversions

A unit conversion object can be provided as an additional parameter to most APIs in order to convert supported values.

The unit conversion parameter is a JSON string. For example:

{"Volume": "m3", "Flow":"l/day"}

Or in a request as:

https://enginei-uat.azure-api.net/reports-vessel/v1/vessels/consumption?vessels=-1&from=2019-07-20T00%3A00%3A00%2B00%3A00&units=%7B%22Volume%22%3A%22m3%22,%20%22Flow%22%3A%22l%2Fday%22%7D

Supported Values

Default values are marked in bold.

Volume

  • Litres: l

  • Cubic metres: m3

Speed
  • Knots: kn

  • Kilometres per hour: km/hr

Length
  • Nautical miles: NM

  • Kilometres: km

Time
  • Seconds: sec

  • Minutes: min

  • Hours: hr

  • Days: day