DRY Trade Flows Voyage Details Results
Header Parameters
Authorizationstring Required
Token used for authentication.
Query Parameters
analysis_idinteger
Id of analysis. If 'analysis_id' is empty:
- 'voyage_type' is required;
- 'date_mode' is required only if 'date_from' or 'date_to' is passed.
pageinteger
page number
stepinteger
maximum number of results
date_fromstring
Date From, format YYYY-MM-DD
date_tostring
Date To, format YYYY-MM-DD
date_modestring
Date mode (required if 'analysis_id' is empty and 'date_from' or 'date_to' is passed)
Enum values:
allstartedendedstarted_and_endedstarted_or_endeddwt_frominteger
DWT From
dwt_tointeger
DWT To
voyage_typestring
Voyage type ('laden' by default. Required if 'analysis_id' is empty)
Enum values:
ladenballastload_stsboolean
Include only Load STS
disch_stsboolean
Include only Disch STS
exclude_cabotageboolean
Exclude Cabotage
only_current_voyagesboolean
Only current voyages
include_predicted_voyagesboolean
Include predicted voyages
include_predicted_voyages-copy-1boolean
Include predicted voyages
commodity_idsinteger
Commodity ids
load_areasinteger
Load Areas (Area ids)
disch_areasinteger
Disch Areas (Area ids)
waypointinteger
Waypoint id
Response
200
Object
An array of voyages.
Response Attributes
totalinteger
resultsarray
Show child attributes
200
Object
Unexpected error
Response Attributes
codeinteger Required
messagestring Required