Short Description
...
Required fields:
Cargo: commodity, charterer, freightCurrency, cargoMeasurement, cargoPorts, optionStatus
POST example:
Code Block | ||
---|---|---|
| ||
{ "cargoMeasurement":"MT", "freightCurrency":"USD", "charterer":30091200, "commodity":11401057, "optionStatus": 1000105, "cargoPorts":[ { "cargoPortSequence":1, "reasonForCall":"L", "port":103309 }, { "cargoPortSequence":1, "reasonForCall":"D", "port":105724 } ], } |
...
To know which should be the first portCallSequence value to use in the JSON, a GET.Voyage/{key} can be done passing the following fields as HTTP header parameter (see Adjust Number of Fields to be Returned from a Request):
{"portCalls":{"portCallSequence":"*"}}
that will return a JSON like this:
...
Property | Type | Length | Mandatory | Description | Comments |
---|---|---|---|---|---|
| |||||
| |||||
| |||||
| String | 256 | |||
| Date | ||||
| String | 16 | |||
| String | 4 | |||
| String | 64 | |||
| Double | ||||
| Array of /CargoPort | ||||
| Array of /Various | ||||
| Array of /Commission | ||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | Defines wether or not the cargo is a template. Template cargoes are created when creating CoA and are used to create fixtures. | Added in version 5.6 | ||
| Boolean | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Yes | ||||
| Yes | ||||
| |||||
| |||||
| Yes | ||||
| Yes | ||||
| Yes | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| |||||
| |||||
| Date | ||||
| Date | ||||
| Date | ||||
| String | 1 | Yes | ||
| String | 64 | |||
| |||||
| |||||
| |||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Double | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Boolean | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Date | ||||
| Double | ||||
| Date | ||||
| Date | ||||
| Double | ||||
| Double | ||||
| Boolean | ||||
| Double | ||||
| Integer | ||||
| Integer | ||||
| Double | ||||
| String | 64 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| String | 25 | |||
| Double | ||||
| Double | ||||
| Double | ||||
| Integer | ||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| Yes | ||||
| Double | ||||
| |||||
| Date | from API 3.3 | |||
| Date | from API 3.3 | |||
| from API 3.3 | ||||
| |||||
| |||||
| Array of /FreightRate | ||||
| Double | ||||
| Boolean | from API 6.26 | |||
| /StatusTypeYes | from API 6.26 |
Note |
---|
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss) |
...