API explorer
Getting Started

Sections

API explorer

Theme switcher

Update Dry Vessel

Header Parameters

Authorizationstring Required

Token used for authentication.

Query Parameters

imostring Required

Vessel imo.

Body Parameters

namestring
builtstring

Date format: Y-m-d. Ex.: 2022-05-25.

flaginteger

Flag id. @see /shipinfo/flags

ship_statusinteger

Ship Status id. @see /shipinfo/statuses

registered_ownerinteger

Registered Owner Company id. @see /companies

ship_ownerinteger

Ship Owner Company id. @see /companies

beneficial_ownerinteger

Beneficial Owner Company id. @see /companies

dwtinteger
summer_fresh_water_dwtinteger
winter_salt_water_dwtinteger
tropical_salt_water_dwtinteger
tropical_fresh_water_dwtinteger
lbpnumber
loanumber
beamnumber
draftnumber
winter_salt_water_draftnumber
tropical_salt_water_draftnumber
summer_fresh_water_draftnumber
tropical_fresh_water_draftnumber
depthnumber
tpcnumber
winter_salt_water_tpcnumber
tropical_salt_water_tpcnumber
summer_fresh_water_tpcnumber
tropical_fresh_water_tpcnumber
air_draftnumber
gtinteger
suez_gtnumber
panama_gtnumber
ntinteger
suez_ntnumber
panama_ntnumber
ldtinteger
shipyardinteger

Shipyard Company id. @see /companies

second_shipyardinteger

Shipyard Company id. @see /companies

hull_numberstring
bow_thrusterstring

Values: '','Y','N'. Default: ''

stern_thrusterstring

Values: '','Y','N'. Default: ''

gearedstring

Values: '','Y','N'. Default: ''

grabs_numberinteger
grabs_capacitynumber
total_decksinteger
grainnumber
balenumber
call_signstring
open_hatchesstring

Values: '','Y','N','OHBS','BOX'. Default: ''

lakes_fittedstring

Values: '','Y','N'. Default: ''

logs_fittedstring

Values: '','Y','N'. Default: ''

ahl_fittedstring

Values: '','Y','N'. Default: ''

co2_fittedstring

Values: '','Y','N'. Default: ''

mmsiinteger
ice_classstring

Values: '','N','Y','IA Super','IA','IB','IC','Category II'. Default: ''

ballast_waterinteger
technical_managerinteger

Technical Manager Company id. @see /companies

poolinteger

Pool Manager Company id. @see /companies

parent_shipownerinteger

Parent Shipowner Company id. @see /companies

doc_holderinteger

Doc Holder Company id. @see /companies

crew_managerinteger

Crew Manager Company id. @see /companies

ism_managerinteger

ISM Manager Company id. @see /companies

dual_fuelstring

Values: '','N','LNG','LNG Ready','Methanol','Hybrid Battery','Ethane','LPG','Rotor Sails','Hydrogen','Ammonia','Ammonia Ready','Methanol Ready'. Default: ''

scrubbersstring

Values: '','Y','N'. Default: ''

bwtsstring

Values: '','Y','N'. Default: ''

ordering_companyinteger

Ordering Company id. @see /companies

full_ballast_speednumber
full_laden_speednumber
eco_ballast_speednumber
eco_laden_speednumber
full_ballast_hsfonumber
full_laden_hsfonumber
eco_ballast_hsfonumber
eco_laden_hsfonumber
port_load_hsfonumber
in_port_idle_hsfonumber
full_ballast_ae_lsmgonumber
full_laden_ae_lsmgonumber
eco_ballast_ae_lsmgonumber
eco_laden_ae_lsmgonumber
port_load_ae_lsmgonumber
in_port_idle_ae_lsmgonumber
full_ballast_lsmgonumber
full_laden_lsmgonumber
eco_ballast_lsmgonumber
eco_laden_lsmgonumber
port_load_lsmgonumber
in_port_idle_lsmgonumber
fresh_waternumber
constantsnumber
full_laden_vlsfonumber
full_ballast_vlsfonumber
eco_laden_vlsfonumber
eco_ballast_vlsfonumber
port_load_vlsfonumber
in_port_idle_vlsfonumber
eco_2_ballast_speednumber
eco_2_laden_speednumber
eco_2_ballast_hsfonumber
eco_2_laden_hsfonumber
eco_2_ballast_ae_lsmgonumber
eco_2_laden_ae_lsmgonumber
eco_2_ballast_lsmgonumber
eco_2_laden_lsmgonumber
eco_2_ballast_vlsfonumber
eco_2_laden_vlsfonumber
canal_hsfonumber
canal_ae_lsmgonumber
canal_lsmgonumber
canal_vlsfonumber
port_disch_hsfonumber
port_disch_ae_lsmgonumber
port_disch_lsmgonumber
port_disch_vlsfonumber
hsfo_tankinteger
lsmgo_tankinteger
vlsfo_tankinteger
hatches_typestring
ttsstring
cranes_typestring

Values: '','A-Frame','AHC','Bulk Conveyor','Crane','Crawler','Derrick','Elevator','Gantry Crane','Grab','Knuckle Boom','Not Applicable','Pedestal','Telescopic','Unknown','Yes','ROV Crane'. Default: ''

cranes_numberinteger

'>'= 0 or null

Default value
0
cranes_swlnumber

'>'= 0 or null

Default value
0
cranes_outreachinteger

'>'= 0 or null

Default value
0
cranes_positionstring

Values: '','p','c','s'. Default: ''

Response

200
Object

Update Vessel resource.

Response Attributes

idinteger
imointeger
axs_notes_drystring
namestring
registered_ownerstring
registered_owner_idinteger
registered_owner_flagstring
registered_owner_flag_idinteger
ship_ownerstring
ship_owner_idinteger
ship_owner_flagstring
ship_owner_flag_idinteger
tc_operatorstring
tc_operator_idinteger
tc_operator_flagstring
tc_operator_flag_idinteger
beneficial_ownerstring
beneficial_owner_idinteger
beneficial_owner_flagstring
beneficial_owner_flag_idinteger
builtstring

Date format: Y-m-d. Ex.: 2022-05-25.

demolition_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

dwtinteger
summer_fresh_water_dwtinteger
winter_salt_water_dwtinteger
tropical_salt_water_dwtinteger
tropical_fresh_water_dwtinteger
lbpnumber
loanumber
beamnumber
draftnumber
winter_salt_water_draftnumber
tropical_salt_water_draftnumber
summer_fresh_water_draftnumber
tropical_fresh_water_draftnumber
depthnumber
tpcnumber
winter_salt_water_tpcnumber
tropical_salt_water_tpcnumber
summer_fresh_water_tpcnumber
tropical_fresh_water_tpcnumber
air_draftnumber
gtinteger
suez_gtnumber
panama_gtnumber
ntinteger
suez_ntnumber
panama_ntnumber
ldtinteger
shipyardstring
shipyard_idinteger
shipyard_flagstring
shipyard_flag_idinteger
second_shipyardstring
second_shipyard_idinteger
second_shipyard_flagstring
second_shipyard_flag_idinteger
hull_numberstring
total_main_enginesinteger
bow_thrusterstring
stern_thrusterstring
gearedstring
grabs_numberinteger
grabs_capacitynumber
total_decksinteger
grainnumber
balenumber
holdsinteger
hatchesinteger
activestring
call_signstring
open_hatchesstring
lakes_fittedstring
logs_fittedstring
ahl_fittedstring
co2_fittedstring
keel_laying_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

launching_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

reported_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

cancelled_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

mmsiinteger
ice_classstring
ballast_waterinteger
technical_managerstring
technical_manager_idinteger
technical_manager_flagstring
technical_manager_flag_idinteger
poolstring
pool_idinteger
pool_flagstring
pool_flag_idinteger
parent_shipownerstring
parent_shipowner_idinteger
parent_shipowner_flagstring
parent_shipowner_flag_idinteger
doc_holderstring
doc_holder_idinteger
doc_holder_flagstring
doc_holder_flag_idinteger
crew_managerstring
crew_manager_idinteger
crew_manager_flagstring
crew_manager_flag_idinteger
ism_managerstring
ism_manager_idinteger
ism_manager_flagstring
ism_manager_flag_idinteger
dual_fuelstring
scrubbersstring
bwtsstring
ordering_companystring
ordering_company_idinteger
ordering_company_flagstring
ordering_company_flag_idinteger
full_ballast_speednumber
full_laden_speednumber
eco_ballast_speednumber
eco_laden_speednumber
full_ballast_hsfonumber
full_laden_hsfonumber
eco_ballast_hsfonumber
eco_laden_hsfonumber
port_load_hsfonumber
in_port_idle_hsfonumber
full_ballast_ae_lsmgonumber
full_laden_ae_lsmgonumber
eco_ballast_ae_lsmgonumber
eco_laden_ae_lsmgonumber
port_load_ae_lsmgonumber
in_port_idle_ae_lsmgonumber
full_ballast_lsmgonumber
full_laden_lsmgonumber
eco_ballast_lsmgonumber
eco_laden_lsmgonumber
port_load_lsmgointeger
in_port_idle_lsmgonumber
fresh_waternumber
constantsinteger
full_laden_vlsfonumber
full_ballast_vlsfonumber
eco_laden_vlsfonumber
eco_ballast_vlsfonumber
port_load_vlsfonumber
in_port_idle_vlsfonumber
eco_2_ballast_speednumber
eco_2_laden_speednumber
eco_2_ballast_hsfonumber
eco_2_laden_hsfonumber
eco_2_ballast_ae_lsmgonumber
eco_2_laden_ae_lsmgonumber
eco_2_ballast_lsmgonumber
eco_2_laden_lsmgonumber
eco_2_ballast_vlsfonumber
eco_2_laden_vlsfonumber
canal_hsfonumber
canal_ae_lsmgonumber
canal_lsmgonumber
canal_vlsfonumber
port_disch_hsfonumber
port_disch_ae_lsmgonumber
port_disch_lsmgonumber
port_disch_vlsfonumber
hsfo_tankinteger
lsmgo_tankinteger
vlsfo_tankinteger
hatches_typestring
ttsstring
update_datestring

Date format: Y-m-d H:i:s. Ex.: 2022-05-25 14:36:05.

typestring
type_idinteger
subtypestring
subtype_idinteger
ship_statusstring
ship_status_idinteger
flagstring
flag_idstring
designstring
design_idstring
shipbuilding_groupstring
shipbuilding_group_idinteger
shipbuilding_group_flagstring
shipbuilding_group_flag_idinteger
demolition_countrystring
demolition_country_idinteger
categorystring
category_idstring
market_segmentstring
market_segment_idinteger
exnamesstring
me_builderstring
me_designstring
me_modelstring
me_kw_totalinteger
me_hpinteger
me_rpminteger
ae_numberinteger
last_dd_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

next_dd_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

last_ss_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

next_ss_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

class_societystring
cranes_typestring
cranes_numberinteger
cranes_swlnumber
cranes_outreachinteger
cranes_positionstring
hold_detailsstring
hatches_detailsstring
private_commentsinteger
private_tagsstring
private_notesstring
conversion_datestring

Date format: Y-m-d. Ex.: 2022-05-25.

codeinteger Required
messagestring Required
403
Object

Access Denied.

Response Attributes

messagestring
404
Object

Resource not found.

Response Attributes

messagestring
422
Object

Validation Errors.

Response Attributes

errorsarray

PUT

/

Select
1

Response