vortexasdk.api.vessel

VesselEntityCorporateEntity

VesselEntityCorporateEntity(*, id: str, label: typing.Optional[str],
                            layer: typing.Optional[str],
                            end_timestamp: typing.Optional[str],
                            start_timestamp: typing.Optional[str])

model_config

VesselEntityCorporateEntityWithConfidence

VesselEntityCorporateEntityWithConfidence(
  *, probability: typing.Optional[float], source: typing.Optional[str],
  id: typing.Optional[str], label: typing.Optional[str],
  layer: typing.Optional[str], end_timestamp: typing.Optional[str],
  start_timestamp: typing.Optional[str])

model_config

Vessel

Vessel(
  *, id: str, name: typing.Optional[str], ref_type: typing.Optional[str],
  leaf: typing.Optional[bool], parent:
    typing.Optional[typing.List[vortexasdk.api.shared_types.IDNameLayer]],
  related_names: typing.Optional[list], mmsi: typing.Optional[int],
  layer: typing.Optional[typing.List[str]],
  tags: typing.Optional[typing.List[vortexasdk.api.shared_types.Tag]],
  current_product_type: typing.Optional[typing.List[typing.Any]],
  vessel_class: typing.Optional[str], classes:
    typing.Optional[typing.List[vortexasdk.api.shared_types.VesselClassEntry]],
  vessel_status: typing.Optional[str], corporate_entities:
    typing.Optional[typing.List[vortexasdk.api.vessel.VesselEntityCorporateEntity]],
  dead_weight: typing.Optional[int],
  cubic_capacity: typing.Optional[int], to_bow: typing.Optional[int],
  to_stern: typing.Optional[int], to_port: typing.Optional[int],
  to_starboard: typing.Optional[int], call_sign: typing.Optional[str],
  year: typing.Optional[int], imo: typing.Optional[int],
  gross_tonnage: typing.Optional[int], scrubber:
    typing.Optional[typing.List[vortexasdk.api.shared_types.Scrubber]],
  flag: typing.Optional[typing.List[vortexasdk.api.shared_types.Flag]],
  ice_class: typing.Optional[str], propulsion: typing.Optional[str])

Represent a Vessel reference record returned by the API.

Vessels Further Documentation

model_config

VesselEntity

VesselEntity(
  *, id: str, name: typing.Optional[str], mmsi: typing.Optional[int],
  imo: typing.Optional[int], dwt: typing.Optional[int],
  vessel_class: typing.Optional[str], classes:
    typing.Optional[typing.List[vortexasdk.api.shared_types.VesselClassEntry]],
  corporate_entities:
    typing.Optional[typing.List[vortexasdk.api.vessel.VesselEntityCorporateEntityWithConfidence]],
  tags: typing.Optional[typing.List[vortexasdk.api.shared_types.Tag]],
  status: typing.Optional[str], year: typing.Optional[int],
  start_timestamp: typing.Optional[str],
  cubic_capacity: typing.Optional[int], voyage_id: typing.Optional[str],
  fixture_fulfilled: typing.Optional[bool],
  end_timestamp: typing.Optional[str], fixture_id: typing.Optional[str],
  scrubber:
    typing.Optional[typing.List[vortexasdk.api.shared_types.Scrubber]],
  flag: typing.Optional[typing.List[vortexasdk.api.shared_types.Flag]],
  ice_class: typing.Optional[str], propulsion: typing.Optional[str])

A VesselEntity represents a vessel record used in CargoMovements.

Vessel Entities Further Documentation

model_config