/Vessel
Short Description
Chapter Contents:
Long Description
Supported Methods
GET /Vessel
Get a list of Vessel objects. Filter to avoid huge amounts of data (see Filtering for search parameters).
GET /Vessel/{key}
Get a single Vessel object.
PUT /Vessel/{key}
Update an existing Vessel. Unchanged properties need not be updated.
POST /Vessel
Insert a new Vessel object.
Properties
Property | Type | Length | Mandatory | Description | Comments |
---|---|---|---|---|---|
vesselName | String | 40 | Yes | ||
imoNumber | String | 7 | |||
vesselType | /VesselType | ||||
flag | /Country | ||||
registeredPort | /Port | ||||
vesselCodes | Array of /VesselCode | ||||
voyageCurrency | /Currency | ||||
doAtSea | Double | ||||
doInPort | Double | ||||
doInerting | Double | ||||
doInPortWorking | Double | ||||
foCleaning | Double | ||||
foInPort | Double | ||||
foInPortWorking | Double | ||||
foPumping | Double | ||||
dwtSummer | Double | ||||
cubicGrain | Double | ||||
foGeneratorLoading | Double | ||||
foGeneratorDischarging | Double | ||||
foHeatingPerDay | Double | ||||
airDraft | Double | ||||
auxEngine | String | 128 | |||
beam | Double | ||||
bhpNormalContinousRating | Double | ||||
bowThruster | String | 128 | |||
builtShipyard | String | 32 | |||
builtYear | Integer | ||||
callSignal | String | 7 | |||
capacityBallastWater | Double | ||||
capacityDo | Double | ||||
capacityFo | Double | ||||
capacityWater | Double | ||||
constantReduction | Double | ||||
cubicBales | Double | ||||
cubicDeck | Double | ||||
cubicOil | Double | ||||
cubicWing | Double | ||||
depth | Double | ||||
doGeneratorAtSeaReefer | Double | ||||
doGeneratorDischarging | Double | ||||
doManouvering | Double | ||||
draftDesign | Double | ||||
draftFresh | Double | ||||
draftMeasurement | String | 1 | |||
draftSummer | Double | ||||
draftTropical | Double | ||||
draftTropicalFresh | Double | ||||
draftWinter | Double | ||||
dwtDesign | Double | ||||
dwtFresh | Double | ||||
dwtPanama | Double | ||||
dwtTropical | Double | ||||
dwtTropicalFresh | Double | ||||
dwtWinter | Double | ||||
foGeneratorAtSea | Double | ||||
foGeneratorAtSeaReefer | Double | ||||
gear | String | 30 | |||
hasGrabsOnboard | Boolean | ||||
hatchcoverStrength | String | 64 | |||
holdAreaLength | Integer | ||||
holdAreaWidth | Integer | ||||
holdsHatches | String | 30 | |||
iceClass | String | 64 | |||
imdgCargo | String | 256 | |||
immersionDesign | Double | ||||
immersionFresh | Double | ||||
immersionMeasurement | String | 3 | |||
immersionSummer | Double | ||||
immersionTropical | Double | ||||
immersionTropicalFresh | Double | ||||
immersionWinter | Double | ||||
inHoldCapacity30ft | Integer | ||||
inHoldCapacity45ft | Integer | ||||
inHoldCapacityHighCube | String | 64 | |||
internationalGt | Double | ||||
internationalNt | Double | ||||
isOshaFitted | Boolean | ||||
lloydsNumber | String | 7 | |||
loa | Double | ||||
lpp | Double | ||||
mainEngine | String | 128 | |||
nomIntakeInHoldFeuFeu | Integer | ||||
nomIntakeInHoldFeuReefer | Integer | ||||
nomIntakeInHoldFeuTeu | Integer | ||||
nomIntakeInHoldTeuFeu | Integer | ||||
nomIntakeInHoldTeuTeu | Integer | ||||
nomIntakeOnDeckFeuFeu | Integer | ||||
nomIntakeOnDeckFeuReefer | Integer | ||||
nomIntakeOnDeckFeuTeu | Integer | ||||
nomIntakeOnDeckTeuFeu | Integer | ||||
nomIntakeOnDeckTeuTeu | Integer | ||||
ntPanama | Double | ||||
ntSuez | Double | ||||
onDeckCapacity30ft | Integer | ||||
onDeckCapacity45ft | Integer | ||||
onDeckCapacityHighCube | String | 64 | |||
pontoonWeight | String | 64 | |||
reeferPlugs | Integer | ||||
rpmNormalContinousRating | Double | ||||
shaftGenerator | String | 128 | |||
stackweightInHold | String | 64 | |||
stackweightInHoldFeu | Double | ||||
stackweightInHoldTeu | Double | ||||
stackweightOnDeck | String | 64 | |||
stackweightOnDeckFeu | Double | ||||
stackweightOnDeckTeu | Double | ||||
stackweightOnHatches | String | 64 | |||
stackweightOnHatchesFeu | Double | ||||
stackweightOnHatchesTeu | Double | ||||
sternThruster | String | 128 | |||
tanktopStrength | String | 32 | |||
vesselDesign | String | 32 | |||
classificationSociety | /ClassificationSociety | ||||
cubicMeasurement | /Measurement | ||||
dwtMeasurement | /Measurement | ||||
hatchCoverType | /HatchCoverType | ||||
shipRegister | /ShipRegister | ||||
speeds | Array of /Speed | ||||
twistLockType | /TwistLockType | ||||
owner | /BusinessPartner | ||||
scrubberFittedMe | Boolean | from 3.4 | |||
contactInfo | Array of /ContactInfo | List of Contact Infos for Vessel | from 3.5 | ||
openPosition | /PortCall | This is a calculated field | |||
bunkerTypes | Array of /BunkerType | from 3.19 | |||
scenarios | Array of /Scenario | from 5.32 | |||
isOpenLoopScrubber | Boolean | ||||
recordStatus | Boolean | Available from version 6.20 |
POST Vessel example
{ "vesselName":"VESSEL NAME", "vesselType":1041612, "doInerting":0, "foInerting":0, "speeds":[ { "foConsumption":12, "isActive":true, "speed":12, "speedType":"L" }, { "foConsumption":12, "isActive":true, "speed":11, "speedType":"B" } ], "vesselCodes":[ { "defaultBusinessUnit":1792747, "defaultCompany":12256130, "vesselCode":"VESSEL NAME" } ] }
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)
Example Response Body
{ "vesselName": "Vessel 1", "imoNumber": "9380764", "vesselType": { "key": 1002374, "self": "http://platform-dev.dataloy.com:80/ws/rest/VesselType/1002374", "vesselTypeDesc": "OPEN HATCH CARRIER", "vesselTypeCode": null }, "flag": { "countryCode": "HK", "countryName": "Hong Kong", "key": 410088, "self": "http://platform-dev.dataloy.com:80/ws/rest/Country/410088" }, "registeredPort": null, "contactInfo": [ { "phoneNo": null, "mobileNo": null, "faxNo": null, "telexNo": null, "email": null, "key": 19749941, "self": "http://platform-dev.dataloy.com:80/ws/rest/ContactInfo/19749941" } ], "vesselCodes": [ { "key": 19052065, "self": "http://platform-dev.dataloy.com:80/ws/rest/VesselCode/19052065", "vesselCode": "222" } ], "openPosition": { "key": 336169023, "self": "http://platform-dev.dataloy.com:80/ws/rest/PortCall/336169023", "eventLogs": [ { "key": 336169029, "self": "http://platform-dev.dataloy.com:80/ws/rest/EventLog/336169029", "event": { "key": 1000052, "self": "http://platform-dev.dataloy.com:80/ws/rest/Event/1000052", "eventCode": "DEP", "eventDesc": "Departed" }, "eventLogDate": "2018-09-10T11:50:00" }, { "key": 336169025, "self": "http://platform-dev.dataloy.com:80/ws/rest/EventLog/336169025", "event": { "key": 1000050, "self": "http://platform-dev.dataloy.com:80/ws/rest/Event/1000050", "eventCode": "ARR", "eventDesc": "Arrived" }, "eventLogDate": "2018-09-10T11:50:00" }, { "key": 336169027, "self": "http://platform-dev.dataloy.com:80/ws/rest/EventLog/336169027", "event": { "key": 1000051, "self": "http://platform-dev.dataloy.com:80/ws/rest/Event/1000051", "eventCode": "BRT", "eventDesc": "Berthed" }, "eventLogDate": "2018-09-10T11:50:00" } ] }, "createdDate": "2008-05-26T14:18:20", "modifiedDate": "2016-11-01T14:38:09", "createdById": 1000633, "voyageCurrency": null, "constantReduction": 0, "doGeneratorDischarging": 0, "doManouvering": 0, "foGeneratorAtSea": 0, "foGeneratorDischarging": 4, "foGeneratorLoading": 4, "foHeatingPerDay": 0, "speeds": [ { "key": 64301209, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/64301209" }, { "key": 64301213, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/64301213" }, { "key": 64301234, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/64301234" }, { "key": 70259703, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/70259703" }, { "key": 19052052, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/19052052" }, { "key": 64301230, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/64301230" }, { "key": 70259697, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/70259697" }, { "key": 19052050, "self": "http://platform-dev.dataloy.com:80/ws/rest/Speed/19052050" } ], "doAtSea": 0.1, "doInPort": 0.1, "doInPortWorking": 0.1, "foCleaning": 0, "foInPort": 0, "foInPortWorking": 0, "foPumping": 0, "draftMeasurement": "M", "dwtSummer": 46882, "cubicGrain": 1879870, "iceClass": null, "classificationSociety": { "key": 913801, "self": "http://platform-dev.dataloy.com:80/ws/rest/ClassificationSociety/913801", "classificationSocietyCode": "DNV", "classificationSocietyName": "DNV GL" }, "dwtMeasurement": { "measurementCode": "MT", "key": 1000623, "self": "http://platform-dev.dataloy.com:80/ws/rest/Measurement/1000623" }, "cubicMeasurement": { "measurementCode": "CUFT", "key": 1000626, "self": "http://platform-dev.dataloy.com:80/ws/rest/Measurement/1000626" }, "loa": 199.2, "beam": 30.5, "draftSummer": 11.82, "airDraft": 0, "auxEngine": null, "bhpNormalContinousRating": 0, "bowThruster": null, "builtShipyard": null, "builtYear": 2007, "callSignal": null, "capacityBallastWater": 0, "capacityDo": 171, "capacityFo": 2802, "capacityWater": 0, "cubicBales": 1879870, "cubicDeck": 0, "cubicOil": 0, "cubicWing": 0, "depth": 16.4, "doGeneratorAtSeaReefer": 0, "draftDesign": 0, "draftFresh": 0, "draftTropical": 0, "draftTropicalFresh": 0, "draftWinter": 0, "dwtDesign": 0, "dwtFresh": 0, "dwtPanama": 0, "dwtTropical": 0, "dwtTropicalFresh": 0, "dwtWinter": 0, "foGeneratorAtSeaReefer": 0, "gear": "2 x Gantry 40", "hasGrabsOnboard": false, "hatchcoverStrength": null, "holdAreaLength": null, "holdAreaWidth": null, "holdsHatches": "10", "imdgCargo": null, "immersionDesign": 0, "immersionFresh": 0, "immersionMeasurement": "TPI", "immersionSummer": 53.7, "immersionTropical": 0, "immersionTropicalFresh": 0, "immersionWinter": 0, "inHoldCapacity30ft": null, "inHoldCapacity45ft": null, "inHoldCapacityHighCube": null, "internationalGt": 29758, "internationalNt": 14440, "isOshaFitted": false, "lloydsNumber": null, "lpp": 0, "mainEngine": null, "nomIntakeInHoldFeuFeu": null, "nomIntakeInHoldFeuReefer": null, "nomIntakeInHoldFeuTeu": null, "nomIntakeInHoldTeuFeu": null, "nomIntakeInHoldTeuTeu": null, "nomIntakeOnDeckFeuFeu": null, "nomIntakeOnDeckFeuReefer": null, "nomIntakeOnDeckFeuTeu": null, "nomIntakeOnDeckTeuFeu": null, "nomIntakeOnDeckTeuTeu": null, "ntPanama": 0, "ntSuez": 0, "onDeckCapacity30ft": null, "onDeckCapacity45ft": null, "onDeckCapacityHighCube": null, "pontoonWeight": null, "reeferPlugs": null, "rpmNormalContinousRating": 0, "scrubberFittedMe": false, "shaftGenerator": null, "stackweightInHold": null, "stackweightInHoldFeu": 0, "stackweightInHoldTeu": 0, "stackweightOnDeck": null, "stackweightOnDeckFeu": 0, "stackweightOnDeckTeu": 0, "stackweightOnHatches": null, "stackweightOnHatchesFeu": 0, "stackweightOnHatchesTeu": 0, "sternThruster": null, "tanktopStrength": null, "vesselDesign": null, "hatchCoverType": null, "shipRegister": null, "twistLockType": null, "owner": { "businessPartnerName": "Shipholding", "businessPartnerSort": "SHIPHOLDING", "businessPartnerCode": "101", "businessPartnerType": { "businessPartnerType": "HO", "businessPartnerTypeDesc": "Head Owner", "key": 1000037, "self": "http://platform-dev.dataloy.com:80/ws/rest/BusinessPartnerType/1000037" }, "key": 64001784, "self": "http://platform-dev.dataloy.com:80/ws/rest/BusinessPartner/64001784" }, "remarks": [], "isObjectActive": true, "key": 19052049, "self": "http://platform-dev.dataloy.com:80/ws/rest/Vessel/19052049" }