GET v1/fuelTypes/{companyCode}?vesselCode={vesselCode}&apiToken={apiToken}
Returns a list of all fuel types and consumption categories associated with a specific vessel
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
companyCode |
The company you want to receive fuel information for |
string |
Required |
vesselCode |
The vessel code for the associated vessel |
string |
Required |
apiToken |
Your API Token |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
GetVesselFuelDetailsResponseName | Description | Type | Additional information |
---|---|---|---|
VesselFuelTypes | Collection of VesselFuelTypeResponse |
None. |
|
ConsumptionCategories | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "vesselFuelTypes": [ { "type": "sample string 1", "name": "sample string 2", "fuelTypeID": 3, "units": "sample string 4", "trackSulfurContent": true }, { "type": "sample string 1", "name": "sample string 2", "fuelTypeID": 3, "units": "sample string 4", "trackSulfurContent": true } ], "consumptionCategories": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<VesselFuelDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VesselFuelTypes> <VesselFuelType> <Type>sample string 1</Type> <Name>sample string 2</Name> <FuelTypeID>3</FuelTypeID> <Units>sample string 4</Units> <TrackSulfurContent>true</TrackSulfurContent> </VesselFuelType> <VesselFuelType> <Type>sample string 1</Type> <Name>sample string 2</Name> <FuelTypeID>3</FuelTypeID> <Units>sample string 4</Units> <TrackSulfurContent>true</TrackSulfurContent> </VesselFuelType> </VesselFuelTypes> <ConsumptionCategories> <Category>sample string 1</Category> <Category>sample string 2</Category> </ConsumptionCategories> </VesselFuelDetails>