basePath: / consumes: - application/json definitions: ais_position-response: properties: ais_position_items: items: $ref: '#/definitions/ais_position-response-ais_position_item' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - ais_position_items type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time ais_position-response-ais_position_item: properties: callsign: description: vessel's callsign via AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true course: description: course over ground in degrees north-ward format: float type: number x-nullable: true xml: x-add-datatype: true destination: description: vessel's destination via AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: vessel's draught in m format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: estimated time of arrival via AIS format: date-time type: string x-nullable: true xml: x-add-datatype: true heading: description: true heading of keel (hull) via AIS type: integer x-nullable: true xml: x-add-datatype: true imo: description: IMO number type: integer x-nullable: true xml: x-add-datatype: true latitude: description: position latitude received via AIS format: float type: number xml: x-add-datatype: true length: description: vessel's length in m type: integer xml: x-add-datatype: true longitude: description: position longitude received via AIS format: float type: number xml: x-add-datatype: true maneuver: description: special maneuver / blue sign flag type: boolean x-nullable: true xml: x-add-datatype: true mmsi: description: vessel's MMSI number via AIS type: integer xml: x-add-datatype: true name: description: vessel's name via AIS type: string xml: x-add-datatype: true nav_status: description: navigation status as reported via AIS type: integer x-nullable: true xml: x-add-datatype: true nmea: description: raw NMEA string containing AIS position message items: format: ascii type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true nmea_svd: description: raw NMEA string containing AIS static and voyage related data message items: format: ascii type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true shiptype: description: vessel's type of ship code via AIS type: integer xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: speed over ground in knots format: float type: number x-nullable: true xml: x-add-datatype: true timestamp: description: time of reception of AIS position report format: date-time type: string xml: x-add-datatype: true timestamp_svd: description: time of reception of AIS static and voyage related data report format: date-time type: string xml: x-add-datatype: true transponder_class: description: AIS Transponder class, either "A" or "B" format: ascii type: string xml: x-add-datatype: true turn: description: rate of turn in °/min, it might also contain "fast left" or "fast right" if > ±708°/min type: integer x-nullable: true xml: x-add-datatype: true width: description: vessel's width in m type: integer xml: x-add-datatype: true required: - timestamp - course - nav_status - heading - latitude - longitude - maneuver - mmsi - source - speed - transponder_class - turn title: ais_position-item type: object xml: name: ais_position_item x-add-datatype: true ais_static-response: properties: ais_static_items: items: $ref: '#/definitions/ais_static-response-ais_static_item' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - ais_static_items type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time ais_static-response-ais_static_item: properties: callsign: description: vessel's callsign via AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true destination: description: vessel's destination via AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: vessel's draught in m format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: estimated time of arrival via AIS format: date-time type: string x-nullable: true xml: x-add-datatype: true imo: description: IMO number type: integer x-nullable: true xml: x-add-datatype: true length: description: vessel's length in m type: integer xml: x-add-datatype: true mmsi: description: vessel's MMSI number via AIS type: integer xml: x-add-datatype: true name: description: vessel's name via AIS type: string xml: x-add-datatype: true nmea: description: raw NMEA string containing AIS static and voyage related data message items: format: ascii type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true shiptype: description: vessel's type of ship code via AIS type: integer xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true timestamp: description: time of reception of AIS static and voyage related data report format: date-time type: string xml: x-add-datatype: true transponder_class: description: AIS Transponder class, either "A" or "B" format: ascii type: string xml: x-add-datatype: true width: description: vessel's width in m type: integer xml: x-add-datatype: true required: - timestamp - mmsi - name - shiptype - length - width - source - transponder_class - callsign - destination - draught - eta - imo title: ais_static-item type: object xml: name: ais_static_item x-add-datatype: true error-message-response: properties: code: description: correlates to the HTTP status code format: int32 type: integer xml: x-add-datatype: true description: description: more detailed description type: string xml: x-add-datatype: true message: description: short error message type: string xml: x-add-datatype: true status: description: '"error"' example: error format: ascii type: string xml: x-add-datatype: true required: - status - message - description - code type: object fleet-listing-add: properties: vessels: items: $ref: '#/definitions/fleet-listing-add-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: fleet_listing_add namespace: https://apiv2.fleetmon.com fleet-listing-add-vessel: properties: extra: additionalProperties: true description: client-specific extra informations for this vessel title: fleet-listing-add-vessel-extra type: object x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true note: default: '' type: string xml: x-add-datatype: true tags: items: format: ascii type: string xml: name: item x-add-datatype: true type: array x-nullable: true xml: wrapped: true x-add-datatype: true vessel_id: default: -1 description: vessel ID format: int64 type: integer xml: x-add-datatype: true type: object xml: name: vessel x-add-datatype: true fleet-listing-replace: properties: vessels: items: $ref: '#/definitions/fleet-listing-add-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: fleet_listing_replace namespace: https://apiv2.fleetmon.com fleet-request-edit-vessel: properties: extra: additionalProperties: true description: client-specific extra informations for this vessel title: fleet-request-edit-vessel-extra type: object x-nullable: true xml: x-add-datatype: true note: default: '' type: string xml: x-add-datatype: true tags: items: format: ascii type: string xml: name: item x-add-datatype: true type: array x-nullable: true xml: wrapped: true x-add-datatype: true type: object xml: name: fleet_request_edit_vessel namespace: https://apiv2.fleetmon.com fleet-response-add-vessel-done: allOf: - $ref: '#/definitions/fleet-listing-add-vessel' - properties: detail_url: description: URL path to this item type: string required: - detail_url type: object xml: name: item x-add-datatype: true fleet-response-add-vessel-failed: allOf: - $ref: '#/definitions/fleet-listing-add-vessel' - properties: message: description: description for failure type: string required: - message type: object xml: name: item x-add-datatype: true fleet-response-delete: properties: items_removed: description: number of removed items format: int64 type: integer xml: x-add-datatype: true message: type: string xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true status: description: '"success"' example: success type: string xml: x-add-datatype: true required: - status - message - items_removed type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-edit: properties: changed: description: list of changed attributes items: type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true message: type: string xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true status: description: '"success"' example: success type: string xml: x-add-datatype: true required: - status - message - changed type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/fleet-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-listing-add: properties: items_added: items: $ref: '#/definitions/fleet-response-add-vessel-done' type: array xml: wrapped: true x-add-datatype: true items_existing: items: $ref: '#/definitions/fleet-response-add-vessel-done' type: array xml: wrapped: true x-add-datatype: true items_failed: items: $ref: '#/definitions/fleet-response-add-vessel-failed' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true success: type: boolean xml: x-add-datatype: true required: - success type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-listing-replace: properties: items_added: items: $ref: '#/definitions/fleet-response-add-vessel-done' type: array xml: wrapped: true x-add-datatype: true items_failed: items: $ref: '#/definitions/fleet-response-add-vessel-failed' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true success: type: boolean xml: x-add-datatype: true required: - success type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-listing-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true detail_url: description: URL path to this item type: string xml: x-add-datatype: true extra: additionalProperties: true description: client-specific extra informations for this vessel title: fleet-response-listing-vessel-extra type: object x-nullable: true xml: x-add-datatype: true fleetmon_url: description: FleetMon URL to vessel format: ascii type: string xml: x-add-datatype: true image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true modified: format: date-time type: string xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true note: default: '' type: string xml: x-add-datatype: true position: $ref: '#/definitions/fleet-response-listing-vessel-position' tags: items: format: ascii type: string xml: name: item x-add-datatype: true type: array x-nullable: true xml: wrapped: true x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: default: -1 description: vessel ID format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/fleet-response-listing-vessel-voyage' vt_verbose: type: string x-nullable: true xml: x-add-datatype: true required: - voyage - name - cn_iso2 - imo_number - extra - vessel_id - modified - note - mmsi_number - callsign - type_code - vt_verbose - cn_name - position - fleetmon_url - image_url - tags - type_class - detail_url title: vessel type: object xml: name: vessel x-add-datatype: true fleet-response-listing-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true is_moving: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - is_moving - received - true_heading - longitude - source - in_special_maneuver - latitude - course_over_ground - speed title: position type: object x-nullable: true xml: x-add-datatype: true fleet-response-listing-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true required: - draught - destination - eta title: voyage type: object xml: x-add-datatype: true fleet-response-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true extra: additionalProperties: true description: client-specific extra informations for this vessel title: fleet-response-vessel-extra type: object x-nullable: true xml: x-add-datatype: true fleetmon_url: description: FleetMon URL to vessel format: ascii type: string xml: x-add-datatype: true image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true modified: format: date-time type: string xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true note: default: '' type: string xml: x-add-datatype: true position: $ref: '#/definitions/fleet-response-vessel-position' request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true size_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `size_limit_info` is `true` properties: current_changes: description: Number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true current_list_size: description: Number of vessels currently in this endpoint. type: integer xml: x-add-datatype: true max_changes: description: Maximum number of vessel changes in this endpoint within the last 30 days. type: integer xml: x-add-datatype: true max_list_size: description: Maximum number of vessels in this endpoint. type: integer xml: x-add-datatype: true required: - current_changes - current_list_size - max_changes - max_list_size title: size-limit-info type: object xml: x-add-datatype: true tags: items: format: ascii type: string xml: name: item x-add-datatype: true type: array x-nullable: true xml: wrapped: true x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: default: -1 description: vessel ID format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/fleet-response-vessel-voyage' vt_verbose: type: string x-nullable: true xml: x-add-datatype: true required: - voyage - name - cn_iso2 - imo_number - extra - vessel_id - modified - note - mmsi_number - callsign - type_code - vt_verbose - cn_name - position - fleetmon_url - image_url - tags - type_class title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time fleet-response-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true is_moving: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - is_moving - received - true_heading - longitude - source - in_special_maneuver - latitude - course_over_ground - speed title: position type: object x-nullable: true xml: x-add-datatype: true fleet-response-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true required: - draught - destination - eta title: voyage type: object xml: x-add-datatype: true geo_distance-to-port: properties: edge_count: description: Number of traversed edges in the routing graph for this route type: integer xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true total_cost: description: Total cost in seconds type: integer xml: x-add-datatype: true total_distance: description: Total distance in meters format: float type: number xml: x-add-datatype: true required: - total_cost - total_distance - edge_count title: distance-to-port type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time get-user-login-token: description: User Login token generator properties: login_token: description: Login Token for Token Key type: string xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - login_token title: user-login-token type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time lng_vessel_events-response-event: properties: event_type: type: string xml: x-add-datatype: true new_value: type: string xml: x-add-datatype: true old_value: type: string xml: x-add-datatype: true timestamp: format: date-time type: string xml: x-add-datatype: true vessel: $ref: '#/definitions/lng_vessel_events-response-event-vessel' required: - vessel - timestamp - event_type - old_value - new_value title: event type: object xml: name: event x-add-datatype: true lng_vessel_events-response-event-vessel: description: vessel object properties: mmsi_number: description: vessel mmsi number format: int64 type: integer xml: x-add-datatype: true name: description: vessel name type: string x-nullable: true xml: x-add-datatype: true vessel_id: format: int64 type: integer xml: x-add-datatype: true required: - vessel_id - mmsi_number - name title: vessel type: object xml: name: vessel x-add-datatype: true lng_vessel_events-response-listing: properties: events: items: $ref: '#/definitions/lng_vessel_events-response-event' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - events title: lng-vessel-events type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time lng_vessel_events-response-listing-single: properties: events: items: $ref: '#/definitions/lng_vessel_events-response-listing-single-event' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - events title: lng-vessel-events type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time lng_vessel_events-response-listing-single-event: properties: event_type: type: string xml: x-add-datatype: true new_value: type: string xml: x-add-datatype: true old_value: type: string xml: x-add-datatype: true timestamp: format: date-time type: string xml: x-add-datatype: true vessel: $ref: '#/definitions/lng_vessel_events-response-listing-single-vessel' required: - vessel - timestamp - event_type - old_value - new_value title: event type: object xml: name: event x-add-datatype: true lng_vessel_events-response-listing-single-vessel: description: vessel object properties: mmsi_number: description: vessel mmsi number format: int64 type: integer xml: x-add-datatype: true name: description: vessel name type: string x-nullable: true xml: x-add-datatype: true vessel_id: format: int64 type: integer xml: x-add-datatype: true required: - vessel_id - mmsi_number - name title: vessel type: object xml: name: vessel x-add-datatype: true logistics_vessel-response-vessel: properties: imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true last_port: $ref: '#/definitions/logistics_vessel-response-vessel-last_port' mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true next_port: $ref: '#/definitions/logistics_vessel-response-vessel-next_port' position: $ref: '#/definitions/logistics_vessel-response-vessel-position' request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/logistics_vessel-response-vessel-voyage' required: - voyage - last_port - name - imo_number - mmsi_number - position - next_port - vessel_id title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time logistics_vessel-response-vessel-last_port: description: Last recorded portcall properties: ata: description: actual time of arrival (of last port) format: date-time type: string xml: x-add-datatype: true atd: description: actual time of departure, if `null` the portcall is ongoing format: date-time type: string x-nullable: true xml: x-add-datatype: true locode: description: last port Locode format: ascii type: string x-nullable: true xml: x-add-datatype: true name: description: last port name type: string xml: x-add-datatype: true required: - atd - name - locode - ata title: port-last type: object xml: x-add-datatype: true logistics_vessel-response-vessel-next_port: description: Port the vessel is heading to, if matching from AIS "destination" was possible properties: eta_calc: description: ETA at next port calculated by FleetMon format: date-time type: string x-nullable: true xml: x-add-datatype: true locode: description: Locode of the next port format: ascii type: string x-nullable: true xml: x-add-datatype: true name: description: matched next port name type: string xml: x-add-datatype: true travel_distance_nm: description: distance to next port in nautical miles format: float type: number x-nullable: true xml: x-add-datatype: true travel_time_h: description: required time to next port calculated by FleetMon in hours format: float type: number x-nullable: true xml: x-add-datatype: true required: - travel_time_h - name - travel_distance_nm - eta_calc - locode title: port-next type: object x-nullable: true xml: x-add-datatype: true logistics_vessel-response-vessel-position: properties: course_over_ground: description: movement direction received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true nav_status: description: reported navigation status received via AIS (position message) format: ascii type: string xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: heading of vessel received via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - course_over_ground - received - nav_status - true_heading - longitude - latitude - speed title: position type: object x-nullable: true xml: x-add-datatype: true logistics_vessel-response-vessel-voyage: description: Voyage related information from AIS properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true received: description: time of received static message format: date-time type: string xml: x-add-datatype: true required: - draught - received - destination - eta title: voyage type: object xml: x-add-datatype: true meteo_current-response-current-report: properties: current_dir: description: Current direction format: int64 type: integer xml: x-add-datatype: true current_speed: description: Current speed format: float type: number xml: x-add-datatype: true current_u_cmp: description: U-component of current format: float type: number xml: x-add-datatype: true current_v_cmp: description: V-component of current format: float type: number xml: x-add-datatype: true forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true salinity: description: Sea water salinity format: float type: number xml: x-add-datatype: true surface_elevation: description: Sea water surface elevation format: float type: number xml: x-add-datatype: true water_temperature: description: Sea water temperature format: float type: number xml: x-add-datatype: true required: - lat - lon - forecast_time - current_speed - current_dir - current_u_cmp - current_v_cmp - water_temperature - surface_elevation - salinity title: current-report type: object xml: name: response namespace: https://apiv2.fleetmon.com x-add-datatype: true x-extra-attributes: timestamp: type: date-time meteo_current-response-listing: properties: current-reports: items: $ref: '#/definitions/meteo_current-response-listing-current-report' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - current-reports type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time meteo_current-response-listing-current-report: properties: current_dir: description: Current direction format: int64 type: integer xml: x-add-datatype: true current_speed: description: Current speed format: float type: number xml: x-add-datatype: true current_u_cmp: description: U-component of current format: float type: number xml: x-add-datatype: true current_v_cmp: description: V-component of current format: float type: number xml: x-add-datatype: true forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true salinity: description: Sea water salinity format: float type: number xml: x-add-datatype: true surface_elevation: description: Sea water surface elevation format: float type: number xml: x-add-datatype: true water_temperature: description: Sea water temperature format: float type: number xml: x-add-datatype: true required: - lat - lon - forecast_time - current_speed - current_dir - current_u_cmp - current_v_cmp - water_temperature - surface_elevation - salinity title: current-report type: object xml: name: response namespace: https://apiv2.fleetmon.com x-add-datatype: true x-extra-attributes: timestamp: type: date-time meteo_wave-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true wave-reports: items: $ref: '#/definitions/meteo_wave-response-listing-wave-report' type: array xml: wrapped: true x-add-datatype: true required: - wave-reports type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time meteo_wave-response-listing-wave-report: properties: forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true model_runtime: description: Model run time format: date-time type: string xml: x-add-datatype: true pri_wave_dir: description: Primary wave direction format: float type: number xml: x-add-datatype: true pri_wave_period: description: Primary wave mean period format: float type: number xml: x-add-datatype: true sec_wave_dir: description: Secondary wave direction format: float type: number xml: x-add-datatype: true sec_wave_period: description: Secondary wave mean period format: float type: number xml: x-add-datatype: true wave_sigh: description: Significant height of combined wind waves and swell format: float type: number xml: x-add-datatype: true wind_dir: description: Wind direction [from which blowing] format: int64 type: integer xml: x-add-datatype: true wind_speed: description: Wind speed format: float type: number xml: x-add-datatype: true wind_u_cmp: description: U-component of wind format: float type: number xml: x-add-datatype: true wind_v_cmp: description: V-component of wind format: float type: number xml: x-add-datatype: true wind_wave_dir: description: Direction of wind waves format: float type: number xml: x-add-datatype: true wind_wave_period: description: Mean period of wind waves format: float type: number xml: x-add-datatype: true required: - forecast_time - model_runtime - lat - lon - wind_dir - wind_speed - wind_u_cmp - wind_v_cmp - wave_sigh - pri_wave_period - pri_wave_dir - wind_wave_period - wind_wave_dir - sec_wave_period - sec_wave_dir title: wave-report type: object xml: name: wave-report x-add-datatype: true meteo_wave-response-wave-report: properties: forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true model_runtime: description: Model run time format: date-time type: string xml: x-add-datatype: true pri_wave_dir: description: Primary wave direction format: float type: number xml: x-add-datatype: true pri_wave_period: description: Primary wave mean period format: float type: number xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true sec_wave_dir: description: Secondary wave direction format: float type: number xml: x-add-datatype: true sec_wave_period: description: Secondary wave mean period format: float type: number xml: x-add-datatype: true wave_sigh: description: Significant height of combined wind waves and swell format: float type: number xml: x-add-datatype: true wind_dir: description: Wind direction [from which blowing] format: int64 type: integer xml: x-add-datatype: true wind_speed: description: Wind speed format: float type: number xml: x-add-datatype: true wind_u_cmp: description: U-component of wind format: float type: number xml: x-add-datatype: true wind_v_cmp: description: V-component of wind format: float type: number xml: x-add-datatype: true wind_wave_dir: description: Direction of wind waves format: float type: number xml: x-add-datatype: true wind_wave_period: description: Mean period of wind waves format: float type: number xml: x-add-datatype: true required: - forecast_time - model_runtime - lat - lon - wind_dir - wind_speed - wind_u_cmp - wind_v_cmp - wave_sigh - pri_wave_period - pri_wave_dir - wind_wave_period - wind_wave_dir - sec_wave_period - sec_wave_dir title: wave-report type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time meteo_weather-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true weather-reports: items: $ref: '#/definitions/meteo_weather-response-listing-weather-report' type: array xml: wrapped: true x-add-datatype: true required: - weather-reports type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time meteo_weather-response-listing-weather-report: properties: cloud_cover: description: Total Cloud Cover format: int8 type: integer x-nullable: true xml: x-add-datatype: true forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true humidity: description: Relative humidity @ 2m height above ground format: int64 type: integer xml: x-add-datatype: true ice_cover: description: Ice cover format: int8 type: integer xml: x-add-datatype: true land: description: Land-sea mask type: boolean xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true model_runtime: description: Model run time format: date-time type: string xml: x-add-datatype: true pressure: description: Pressure reduced to MSL @ msl format: int64 type: integer xml: x-add-datatype: true temperature: description: Temperature @ 2m height above ground format: float type: number xml: x-add-datatype: true wind_dir: description: Wind direction [from which blowing] format: int64 type: integer xml: x-add-datatype: true wind_gust: description: Wind speed gust @ surface format: float type: number xml: x-add-datatype: true wind_speed: description: Wind speed format: float type: number xml: x-add-datatype: true wind_u_cmp: description: U-component of wind @ 10m height above ground format: float type: number xml: x-add-datatype: true wind_v_cmp: description: V-component of wind @ 10m height above ground format: float type: number xml: x-add-datatype: true required: - forecast_time - model_runtime - lat - lon - wind_dir - wind_speed - wind_u_cmp - wind_v_cmp - wind_gust - temperature - humidity - pressure - land - ice_cover - cloud_cover title: weather-report type: object xml: name: weather-report x-add-datatype: true meteo_weather-response-weather-report: properties: cloud_cover: description: Total Cloud Cover format: int8 type: integer x-nullable: true xml: x-add-datatype: true forecast_time: description: Forecast time format: date-time type: string xml: x-add-datatype: true humidity: description: Relative humidity @ 2m height above ground format: int64 type: integer xml: x-add-datatype: true ice_cover: description: Ice cover format: int8 type: integer xml: x-add-datatype: true land: description: Land-sea mask type: boolean xml: x-add-datatype: true lat: description: Latitude format: float type: number xml: x-add-datatype: true lon: description: Longitude format: float type: number xml: x-add-datatype: true model_runtime: description: Model run time format: date-time type: string xml: x-add-datatype: true pressure: description: Pressure reduced to MSL @ msl format: int64 type: integer xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true temperature: description: Temperature @ 2m height above ground format: float type: number xml: x-add-datatype: true wind_dir: description: Wind direction [from which blowing] format: int64 type: integer xml: x-add-datatype: true wind_gust: description: Wind speed gust @ surface format: float type: number xml: x-add-datatype: true wind_speed: description: Wind speed format: float type: number xml: x-add-datatype: true wind_u_cmp: description: U-component of wind @ 10m height above ground format: float type: number xml: x-add-datatype: true wind_v_cmp: description: V-component of wind @ 10m height above ground format: float type: number xml: x-add-datatype: true required: - forecast_time - model_runtime - lat - lon - wind_dir - wind_speed - wind_u_cmp - wind_v_cmp - wind_gust - temperature - humidity - pressure - land - ice_cover - cloud_cover title: weather-report type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time myfleet-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/myfleet-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time myfleet-response-listing-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true datasheet: $ref: '#/definitions/myfleet-response-listing-vessel-datasheet' image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true last_port: $ref: '#/definitions/myfleet-response-listing-vessel-last_port' mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true next_port: $ref: '#/definitions/myfleet-response-listing-vessel-next_port' position: $ref: '#/definitions/myfleet-response-listing-vessel-position' staticmap_url: description: URL to rendered map image format: ascii type: string xml: x-add-datatype: true statistics: $ref: '#/definitions/myfleet-response-listing-vessel-statistics' type: type: string x-nullable: true xml: x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/myfleet-response-listing-vessel-voyage' required: - staticmap_url - voyage - statistics - name - imo_number - datasheet - mmsi_number - cn_iso2 - last_port - callsign - type_code - position - cn_name - image_url - vessel_id - type - next_port - type_class title: vessel type: object xml: name: vessel x-add-datatype: true myfleet-response-listing-vessel-datasheet: properties: builder: type: string x-nullable: true xml: x-add-datatype: true classification_society: type: string x-nullable: true xml: x-add-datatype: true dead_weight: format: int64 type: integer x-nullable: true xml: x-add-datatype: true design_max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true gross_tonnage: format: int64 type: integer x-nullable: true xml: x-add-datatype: true height: format: float type: number x-nullable: true xml: x-add-datatype: true insurer: type: string x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true manager: type: string x-nullable: true xml: x-add-datatype: true owner: type: string x-nullable: true xml: x-add-datatype: true person_capacity: format: int64 type: integer x-nullable: true xml: x-add-datatype: true service_status: type: string x-nullable: true xml: x-add-datatype: true teu_14mt: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_max: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_reefer: format: int64 type: integer x-nullable: true xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_built: format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_scraped: format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - classification_society - year_built - year_scraped - insurer - person_capacity - builder - length - height - gross_tonnage - width - manager - service_status - design_max_speed - teu_14mt - owner - teu_reefer - teu_max - dead_weight title: datasheet type: object xml: x-add-datatype: true myfleet-response-listing-vessel-last_port: properties: country: type: string xml: x-add-datatype: true latitude: format: float type: number xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number xml: x-add-datatype: true name: type: string xml: x-add-datatype: true seen_last: format: date-time type: string xml: x-add-datatype: true required: - name - country - longitude - seen_last - latitude - locode title: port-last type: object x-nullable: true xml: x-add-datatype: true myfleet-response-listing-vessel-next_port: properties: country: type: string x-nullable: true xml: x-add-datatype: true eta: format: date-time type: string x-nullable: true xml: x-add-datatype: true latitude: format: float type: number x-nullable: true xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true required: - name - country - longitude - eta - latitude - locode title: port-next type: object x-nullable: true xml: x-add-datatype: true myfleet-response-listing-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true is_moving: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true nav_status: description: current navigation status reported via AIS (position message) format: ascii type: string xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - is_moving - received - nav_status - true_heading - in_special_maneuver - source - longitude - latitude - course_over_ground - speed title: position type: object x-nullable: true xml: x-add-datatype: true myfleet-response-listing-vessel-statistics: properties: avg_draught: format: float type: number x-nullable: true xml: x-add-datatype: true avg_speed: format: float type: number x-nullable: true xml: x-add-datatype: true max_draught: format: float type: number x-nullable: true xml: x-add-datatype: true max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true min_draught: format: float type: number x-nullable: true xml: x-add-datatype: true required: - max_draught - min_draught - max_speed - avg_speed - avg_draught title: statistics type: object xml: x-add-datatype: true myfleet-response-listing-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true received: description: time of received static message format: date-time type: string xml: x-add-datatype: true special_cargo: description: Special cargo as announced by AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true required: - received - draught - destination - eta - special_cargo title: voyage type: object xml: x-add-datatype: true myfleet-response-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true datasheet: $ref: '#/definitions/myfleet-response-vessel-datasheet' image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true last_port: $ref: '#/definitions/myfleet-response-vessel-last_port' mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true next_port: $ref: '#/definitions/myfleet-response-vessel-next_port' position: $ref: '#/definitions/myfleet-response-vessel-position' request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true staticmap_url: description: URL to rendered map image format: ascii type: string xml: x-add-datatype: true statistics: $ref: '#/definitions/myfleet-response-vessel-statistics' type: type: string x-nullable: true xml: x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/myfleet-response-vessel-voyage' required: - staticmap_url - voyage - statistics - name - imo_number - datasheet - mmsi_number - cn_iso2 - last_port - callsign - type_code - position - cn_name - image_url - vessel_id - type - next_port - type_class title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time myfleet-response-vessel-datasheet: properties: builder: type: string x-nullable: true xml: x-add-datatype: true classification_society: type: string x-nullable: true xml: x-add-datatype: true dead_weight: format: int64 type: integer x-nullable: true xml: x-add-datatype: true design_max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true gross_tonnage: format: int64 type: integer x-nullable: true xml: x-add-datatype: true height: format: float type: number x-nullable: true xml: x-add-datatype: true insurer: type: string x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true manager: type: string x-nullable: true xml: x-add-datatype: true owner: type: string x-nullable: true xml: x-add-datatype: true person_capacity: format: int64 type: integer x-nullable: true xml: x-add-datatype: true service_status: type: string x-nullable: true xml: x-add-datatype: true teu_14mt: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_max: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_reefer: format: int64 type: integer x-nullable: true xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_built: format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_scraped: format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - classification_society - year_built - year_scraped - insurer - person_capacity - builder - length - height - gross_tonnage - width - manager - service_status - design_max_speed - teu_14mt - owner - teu_reefer - teu_max - dead_weight title: datasheet type: object xml: x-add-datatype: true myfleet-response-vessel-last_port: properties: country: type: string xml: x-add-datatype: true latitude: format: float type: number xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number xml: x-add-datatype: true name: type: string xml: x-add-datatype: true seen_last: format: date-time type: string xml: x-add-datatype: true required: - name - country - longitude - seen_last - latitude - locode title: port-last type: object x-nullable: true xml: x-add-datatype: true myfleet-response-vessel-next_port: properties: country: type: string x-nullable: true xml: x-add-datatype: true eta: format: date-time type: string x-nullable: true xml: x-add-datatype: true latitude: format: float type: number x-nullable: true xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true required: - name - country - longitude - eta - latitude - locode title: port-next type: object x-nullable: true xml: x-add-datatype: true myfleet-response-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true is_moving: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true nav_status: description: current navigation status reported via AIS (position message) format: ascii type: string xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - is_moving - received - nav_status - true_heading - in_special_maneuver - source - longitude - latitude - course_over_ground - speed title: position type: object x-nullable: true xml: x-add-datatype: true myfleet-response-vessel-statistics: properties: avg_draught: format: float type: number x-nullable: true xml: x-add-datatype: true avg_speed: format: float type: number x-nullable: true xml: x-add-datatype: true max_draught: format: float type: number x-nullable: true xml: x-add-datatype: true max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true min_draught: format: float type: number x-nullable: true xml: x-add-datatype: true required: - max_draught - min_draught - max_speed - avg_speed - avg_draught title: statistics type: object xml: x-add-datatype: true myfleet-response-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true received: description: time of received static message format: date-time type: string xml: x-add-datatype: true special_cargo: description: Special cargo as announced by AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true required: - received - draught - destination - eta - special_cargo title: voyage type: object xml: x-add-datatype: true next-port: properties: next-port: $ref: '#/definitions/next-port-next-port-response' description: Next Port interpreted by FleetMon x-nullable: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true static: $ref: '#/definitions/next-port-static-response' description: Static AIS sent by vessel x-nullable: true required: - next-port - static title: next-port-response type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time next-port-next-port-response: description: Next Port interpreted by FleetMon properties: distance_to_port: description: Distance to next port in nautical miles calculated by FleetMon format: int64 type: integer x-nullable: true xml: x-add-datatype: true eta_calc: description: ETA calculated by FleetMon from last AIS position and AIS static format: date-time type: string x-nullable: true xml: x-add-datatype: true locode: description: LOCODE interpreted by FleetMon from AIS static type: string x-nullable: true xml: x-add-datatype: true name: description: Name of next port interpreted by FleetMon from AIS static type: string x-nullable: true xml: x-add-datatype: true port_id: description: FleetMon Port ID format: int64 type: integer x-nullable: true xml: x-add-datatype: true position_received: description: Last position report timestamp format: date-time type: string xml: x-add-datatype: true required: - distance_to_port - eta - locode - name - port_id - position_received title: next-port type: object x-nullable: true xml: name: next-port-response x-add-datatype: true next-port-static-response: description: Static AIS sent by vessel properties: destination: description: Destination sent by vessel type: string x-nullable: true xml: x-add-datatype: true eta: description: ETA sent by vessel format: date-time type: string x-nullable: true xml: x-add-datatype: true received_first_time: description: Timestamp of first time current Destination and ETA was received format: date-time type: string x-nullable: true xml: x-add-datatype: true received_last_time: description: Timestamp of last time an AIS static was received format: date-time type: string xml: x-add-datatype: true required: - destination - eta - received - received_first_time - received_last_time title: static type: object x-nullable: true xml: name: static-response x-add-datatype: true nonaisparticulars-response-vessel: properties: dead_weight: format: int64 type: integer x-nullable: true xml: x-add-datatype: true fleetmon_url: description: FleetMon URL to vessel format: ascii type: string xml: x-add-datatype: true gross_tonnage: format: int64 type: integer x-nullable: true xml: x-add-datatype: true image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true manager: type: string x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true owner: type: string x-nullable: true xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true required: - name - gross_tonnage - fleetmon_url - manager - image_url - owner - dead_weight - vessel_id title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time port_arrivals-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/port_arrivals-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time port_arrivals-response-listing-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true country: type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true position: $ref: '#/definitions/port_arrivals-response-listing-vessel-position' type: type: string x-nullable: true xml: x-add-datatype: true type_coarse: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/port_arrivals-response-listing-vessel-voyage' required: - voyage - name - type_coarse - imo_number - mmsi_number - cn_iso2 - callsign - type_code - country - position - type - vessel_id title: vessel type: object xml: name: vessel x-add-datatype: true port_arrivals-response-listing-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - received - course_over_ground - true_heading - longitude - source - latitude - speed title: position type: object x-nullable: true xml: x-add-datatype: true port_arrivals-response-listing-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true required: - draught - destination - eta title: voyage type: object xml: x-add-datatype: true port_inport-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/port_inport-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time port_inport-response-listing-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true country: type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true position: $ref: '#/definitions/port_inport-response-listing-vessel-position' type: type: string x-nullable: true xml: x-add-datatype: true type_coarse: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/port_inport-response-listing-vessel-voyage' required: - voyage - name - type_coarse - imo_number - mmsi_number - cn_iso2 - callsign - type_code - country - position - type - vessel_id title: vessel type: object xml: name: vessel x-add-datatype: true port_inport-response-listing-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - received - course_over_ground - true_heading - longitude - source - latitude - speed title: position type: object x-nullable: true xml: x-add-datatype: true port_inport-response-listing-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true required: - draught - destination - eta title: voyage type: object xml: x-add-datatype: true portportcall-response-listing: properties: portcalls: items: $ref: '#/definitions/portportcall-response-listing-portcall' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - portcalls type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time portportcall-response-listing-portcall: properties: ata: description: actual time of arrival format: date-time type: string xml: x-add-datatype: true atd: description: actual time of departure, if `null` the portcall is ongoing format: date-time type: string x-nullable: true xml: x-add-datatype: true callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true country: type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true type: type: string x-nullable: true xml: x-add-datatype: true type_coarse: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: format: int64 type: integer xml: x-add-datatype: true required: - atd - name - type_code - imo_number - type_coarse - ata - mmsi_number - cn_iso2 - callsign - country - type - vessel_id title: portcall type: object xml: name: portcall x-add-datatype: true portsearch-response-listing: properties: ports: items: $ref: '#/definitions/portsearch-response-listing-port' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - ports type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time portsearch-response-listing-port: properties: cn_iso2: type: string xml: x-add-datatype: true cn_name: type: string xml: x-add-datatype: true id: format: int64 type: integer xml: x-add-datatype: true latitude: format: float type: number xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true locode_alternatives: description: other known LOCODEs items: format: ascii type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true longitude: format: float type: number xml: x-add-datatype: true name: type: string xml: x-add-datatype: true name_alternatives: description: other commonly used names items: type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true required: - name_alternatives - latitude - cn_name - longitude - cn_iso2 - locode_alternatives - id - locode - name title: port type: object xml: name: port x-add-datatype: true regional_ais-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/regional_ais-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time regional_ais-response-listing-vessel: properties: ais_type_of_ship: description: AIS Type-Of-Ship ID format: int64 type: integer xml: x-add-datatype: true ais_type_of_ship_str: description: AIS Type-Of-Ship verbalization type: string xml: x-add-datatype: true callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true country: type: string x-nullable: true xml: x-add-datatype: true dwt: format: int64 type: integer x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true position: $ref: '#/definitions/regional_ais-response-listing-vessel-position' type: type: string x-nullable: true xml: x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/regional_ais-response-listing-vessel-voyage' width: description: width of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - voyage - name - dwt - imo_number - width - length - vessel_id - mmsi_number - cn_iso2 - callsign - type_code - country - position - type_class - type - ais_type_of_ship - ais_type_of_ship_str title: vessel type: object xml: name: vessel x-add-datatype: true regional_ais-response-listing-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true nav_status: description: current navigation status reported via AIS (position message) format: ascii type: string xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - received - course_over_ground - nav_status - true_heading - longitude - source - in_special_maneuver - latitude - speed title: position type: object x-nullable: true xml: x-add-datatype: true regional_ais-response-listing-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true received: description: time of received static message format: date-time type: string xml: x-add-datatype: true special_cargo: description: Special cargo as announced by AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true required: - received - draught - destination - eta - special_cargo title: voyage type: object xml: x-add-datatype: true status-message-response: properties: description: description: more detailed description type: string xml: x-add-datatype: true message: description: short message type: string xml: x-add-datatype: true status: description: '"success"' example: success format: ascii type: string xml: x-add-datatype: true required: - status - message type: object terminal_call_demo-event: description: zone event properties: destination: description: Vessel's destination, when event occured type: string x-nullable: true xml: x-add-datatype: true draught: description: Vessel' draught, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: Vessel's ETA, when event occured format: date-time type: string x-nullable: true xml: x-add-datatype: true latitude: description: Latitude of vessel position, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude of vessel position, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true timestamp: format: date-time type: string xml: x-add-datatype: true required: - timestamp - draught - eta - destination - latitude - longitude title: event type: object xml: x-add-datatype: true terminal_call_demo-response-call: properties: duration: description: terminal call duration in seconds type: integer xml: x-add-datatype: true entered_event: $ref: '#/definitions/terminal_call_demo-event' id: description: unique call id type: string xml: x-add-datatype: true left_event: $ref: '#/definitions/terminal_call_demo-event' vessel: $ref: '#/definitions/terminal_call_demo-vessel' zone: $ref: '#/definitions/terminal_call_demo-zone' required: - id - vessel - zone - entered_event title: terminal-call type: object xml: name: call x-add-datatype: true terminal_call_demo-response-calls: properties: calls: items: $ref: '#/definitions/terminal_call_demo-response-call' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - calls type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time terminal_call_demo-vessel: description: vessel object properties: callsign: description: vessel callsign type: string x-nullable: true xml: x-add-datatype: true imo: description: vessel imo number format: int64 type: integer x-nullable: true xml: x-add-datatype: true length: description: vessel length format: float type: number x-nullable: true xml: x-add-datatype: true mmsi: description: vessel mmsi number format: int64 type: integer xml: x-add-datatype: true name: description: vessel name type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: vessel id format: int64 type: integer xml: x-add-datatype: true width: description: vessel width format: float type: number x-nullable: true xml: x-add-datatype: true required: - vessel_id - mmsi - imo - name - callsign - length - width title: vessel type: object xml: x-add-datatype: true terminal_call_demo-zone: description: zone object properties: latitude: description: zone area centroid latitude format: float type: number xml: x-add-datatype: true location_description: description: zone location description type: string x-nullable: true xml: x-add-datatype: true longitude: description: zone area centroid longitude format: float type: number xml: x-add-datatype: true name: description: zone name type: string xml: x-add-datatype: true port_name: description: associated port name type: string x-nullable: true xml: x-add-datatype: true zone_id: description: zone id format: int64 type: integer xml: x-add-datatype: true required: - zone_id - latitude - longitude - name - location_description - port_name title: zone type: object xml: x-add-datatype: true vessel-dynamic-ais: properties: course_over_ground: description: Latest course over ground via AIS (position message) in degree format: int64 type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: description: Is vessel in special maneuver type: boolean xml: x-add-datatype: true latitude: description: Latitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true longitude: description: Longitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: false xml: x-add-datatype: true name: description: Vessel name by FleetMon type: string x-nullable: true xml: x-add-datatype: true nav_status: description: Latest navigation status reported via AIS (position message) type: string xml: x-add-datatype: true rate_of_turn: description: Latest rate of turn via AIS (position message) in degree format: int64 type: number x-nullable: true xml: x-add-datatype: true received: description: Latest position received in Zulu time format from AIS (position message) format: date-time type: string x-nullable: false xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true speed: description: Latest speed received via AIS (position message) in knots format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: Latest true heading of keel (hull) via AIS (position message) in degree format: float type: number x-nullable: true xml: x-add-datatype: true required: - latitude - longitude - mmsi - received title: vessel_dynamic_ais type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vessel-identity: properties: callsign: description: Callsign sent by vessel type: string x-nullable: true xml: x-add-datatype: true eni: description: Callsign sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true imo: description: IMO sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true name: description: Name of vessel based on AIS and can be corrected by FleetMon type: string x-nullable: true xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - callsign - imo - mmsi - name title: vessel-identity type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vessel-laytime: items: $ref: '#/definitions/vessel-laytime-item' properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer required: - used_requests title: request-limit-info type: object title: vessel-laytime type: array xml: name: response namespace: https://apiv2.fleetmon.com wrapped: true x-extra-attributes: timestamp: type: date-time vessel-laytime-item: properties: estimated_laytime: description: Estimalted laytime in minutes format: int64 type: number xml: x-add-datatype: true terminal_call_count: description: Number of terminal calls format: int64 type: number xml: x-add-datatype: true terminal_name: description: Name of the terminal type: string xml: x-add-datatype: true zone_id: description: ID of the terminal zone format: int64 type: number xml: x-add-datatype: true required: - estimated_laytime - zone_id - terminal_name - terminal_call_count title: terminal-laytime type: object xml: name: item x-add-datatype: true vessel-position-only: properties: latitude: description: Latitude share of latest position reported by AIS format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude share of latest position reported by AIS format: float type: number x-nullable: true xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true received: description: Latest position received in Zulu time format format: date-time type: string x-nullable: true xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - latitude - longitude - mmsi - received title: vessel-position-only type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vessel-schedule: items: $ref: '#/definitions/vessel-schedule-item' properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer required: - used_requests title: request-limit-info type: object title: vessel-schedule type: array xml: name: response namespace: https://apiv2.fleetmon.com wrapped: true x-extra-attributes: timestamp: type: date-time vessel-schedule-item: properties: eta: description: ETA date in schedule format: date type: string x-nullable: true xml: x-add-datatype: true etd: description: ETD date in schedule format: date type: string x-nullable: true xml: x-add-datatype: true locode: description: LOCODE of the port type: string xml: x-add-datatype: true port_name: description: Name of the port type: string xml: x-add-datatype: true source: description: Data source, CS = Container Schedule type: string xml: x-add-datatype: true updated: description: Schedule stop update datetime format: date-time type: string xml: x-add-datatype: true required: - eta - etd - locode - port_name - source - updated title: schedule_stop type: object xml: name: item x-add-datatype: true vessel_events-response-listing-single: properties: events: items: $ref: '#/definitions/vessel_events-response-listing-single-event' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - events title: vessel_events-response type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vessel_events-response-listing-single-event: properties: event_type: description: Type of event type: string xml: x-add-datatype: true new_value: description: Value after change event type: string xml: x-add-datatype: true old_value: description: Value before change event type: string xml: x-add-datatype: true timestamp: format: date-time type: string xml: x-add-datatype: true vessel: $ref: '#/definitions/vessel_events-response-listing-single-vessel' required: - vessel - timestamp - event_type - old_value - new_value title: event type: object xml: name: event x-add-datatype: true vessel_events-response-listing-single-vessel: description: vessel object properties: mmsi_number: description: vessel mmsi number format: int64 type: integer xml: x-add-datatype: true name: description: vessel name type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: vessel id format: int64 type: integer xml: x-add-datatype: true required: - vessel_id - mmsi_number - name title: vessel type: object xml: name: vessel x-add-datatype: true vessel_route_from_last_port: items: $ref: '#/definitions/vessel_route_from_last_port-item' properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer required: - used_requests title: request-limit-info type: object title: vessel_route_from_last_port type: array xml: name: response namespace: https://apiv2.fleetmon.com wrapped: true x-extra-attributes: timestamp: type: date-time vessel_route_from_last_port-item: properties: cost: description: Duration in seconds format: float type: number xml: x-add-datatype: true distance: description: between the points in meters format: float type: number xml: x-add-datatype: true path: description: WKT LINESTRING for segment type: string xml: x-add-datatype: true seq: description: Element of the route (count from 0,1,2 to n) type: integer xml: x-add-datatype: true required: - cost - distance - path - seq title: path-segment type: object xml: name: item x-add-datatype: true vessel_route_to_next_port: items: $ref: '#/definitions/vessel_route_to_next_port-item' properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer required: - used_requests title: request-limit-info type: object title: vessel_route_to_next_port type: array xml: name: response namespace: https://apiv2.fleetmon.com wrapped: true x-extra-attributes: timestamp: type: date-time vessel_route_to_next_port-item: properties: cost: description: Duration with the given speed in seconds format: float type: number xml: x-add-datatype: true distance: description: between the points of the path in meters format: float type: number xml: x-add-datatype: true from_node_id: description: ID type: integer xml: x-add-datatype: true link_id: description: ID type: integer xml: x-add-datatype: true path: description: WKT LINESTRING for segment type: string xml: x-add-datatype: true seq: description: Element of the route (count from 0,1,2 to n) type: integer xml: x-add-datatype: true required: - cost - distance - from_node_id - link_id - path - seq title: path-segment type: object xml: name: item x-add-datatype: true vesselbasic-response-vessel: properties: ais_type_of_ship: description: AIS Type-Of-Ship ID format: int64 type: integer xml: x-add-datatype: true ais_type_of_ship_str: description: AIS Type-Of-Ship verbalization type: string xml: x-add-datatype: true callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true fleetmon_url: description: FleetMon URL to vessel format: ascii type: string xml: x-add-datatype: true image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true type: type: string x-nullable: true xml: x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - name - mmsi_number - ais_type_of_ship_str - length - vessel_id - width - cn_iso2 - callsign - image_url - type_code - imo_number - cn_name - fleetmon_url - type - ais_type_of_ship - type_class title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vesselparticulars-response-vessel: properties: ais_type_of_ship: description: AIS Type-Of-Ship ID format: int64 type: integer xml: x-add-datatype: true ais_type_of_ship_str: description: AIS Type-Of-Ship verbalization type: string xml: x-add-datatype: true attributes: description: assigned vessel attributes items: type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true datasheet: $ref: '#/definitions/vesselparticulars-response-vessel-datasheet' image_url: description: URL to master image if available format: ascii type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true last_port: $ref: '#/definitions/vesselparticulars-response-vessel-last_port' mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true next_port: $ref: '#/definitions/vesselparticulars-response-vessel-next_port' position: $ref: '#/definitions/vesselparticulars-response-vessel-position' request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true statistics: $ref: '#/definitions/vesselparticulars-response-vessel-statistics' type: type: string x-nullable: true xml: x-add-datatype: true type_class: format: ascii type: string x-nullable: true xml: x-add-datatype: true type_code: format: ascii type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true voyage: $ref: '#/definitions/vesselparticulars-response-vessel-voyage' required: - ais_type_of_ship_str - voyage - last_port - name - imo_number - vessel_id - datasheet - mmsi_number - cn_iso2 - statistics - callsign - type_code - position - cn_name - image_url - attributes - type - ais_type_of_ship - next_port - type_class title: vessel type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vesselparticulars-response-vessel-datasheet: properties: builder: type: string x-nullable: true xml: x-add-datatype: true classification_society: type: string x-nullable: true xml: x-add-datatype: true dead_weight: format: int64 type: integer x-nullable: true xml: x-add-datatype: true design_max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true gross_tonnage: format: int64 type: integer x-nullable: true xml: x-add-datatype: true height: format: float type: number x-nullable: true xml: x-add-datatype: true insurer: type: string x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true manager: type: string x-nullable: true xml: x-add-datatype: true owner: type: string x-nullable: true xml: x-add-datatype: true person_capacity: format: int64 type: integer x-nullable: true xml: x-add-datatype: true service_status: type: string x-nullable: true xml: x-add-datatype: true teu_14mt: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_max: format: int64 type: integer x-nullable: true xml: x-add-datatype: true teu_reefer: format: int64 type: integer x-nullable: true xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_built: format: int64 type: integer x-nullable: true xml: x-add-datatype: true year_scraped: format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - classification_society - year_built - year_scraped - insurer - person_capacity - builder - length - height - gross_tonnage - width - manager - service_status - design_max_speed - teu_14mt - owner - teu_reefer - teu_max - dead_weight title: datasheet type: object xml: x-add-datatype: true vesselparticulars-response-vessel-last_port: properties: country: type: string xml: x-add-datatype: true latitude: format: float type: number xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number xml: x-add-datatype: true name: type: string xml: x-add-datatype: true seen_last: format: date-time type: string xml: x-add-datatype: true required: - name - country - longitude - seen_last - latitude - locode title: port-last type: object x-nullable: true xml: x-add-datatype: true vesselparticulars-response-vessel-next_port: properties: country: type: string x-nullable: true xml: x-add-datatype: true eta: format: date-time type: string x-nullable: true xml: x-add-datatype: true latitude: format: float type: number x-nullable: true xml: x-add-datatype: true locode: format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true required: - name - country - longitude - eta - latitude - locode title: port-next type: object x-nullable: true xml: x-add-datatype: true vesselparticulars-response-vessel-position: description: Last reported position properties: course_over_ground: description: current course over ground via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true in_special_maneuver: type: boolean xml: x-add-datatype: true is_moving: type: boolean xml: x-add-datatype: true latitude: description: current position latitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true location_str: description: verbal description of the current position type: string x-nullable: true xml: x-add-datatype: true longitude: description: current position longitude received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true nav_status: description: current navigation status reported via AIS (position message) format: ascii type: string xml: x-add-datatype: true received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true source: description: either "terrestrial" or "satellite" format: ascii type: string xml: x-add-datatype: true speed: description: current speed received via AIS (position message) format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: current true heading of keel (hull) via AIS (position message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true required: - location_str - is_moving - received - nav_status - true_heading - in_special_maneuver - source - longitude - latitude - course_over_ground - speed title: position type: object x-nullable: true xml: x-add-datatype: true vesselparticulars-response-vessel-statistics: properties: avg_draught: format: float type: number x-nullable: true xml: x-add-datatype: true avg_speed: format: float type: number x-nullable: true xml: x-add-datatype: true max_draught: format: float type: number x-nullable: true xml: x-add-datatype: true max_speed: format: float type: number x-nullable: true xml: x-add-datatype: true min_draught: format: float type: number x-nullable: true xml: x-add-datatype: true required: - max_draught - min_draught - max_speed - avg_speed - avg_draught title: statistics type: object xml: x-add-datatype: true vesselparticulars-response-vessel-voyage: properties: destination: description: current destination received via AIS (static message) format: ascii type: string x-nullable: true xml: x-add-datatype: true draught: description: current draught received via AIS (static message) format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: current ETA by Vessel received via AIS (static message) format: date-time type: string x-nullable: true xml: x-add-datatype: true received: description: time of received static message format: date-time type: string xml: x-add-datatype: true special_cargo: description: Special cargo as announced by AIS format: ascii type: string x-nullable: true xml: x-add-datatype: true required: - received - draught - destination - eta - special_cargo title: voyage type: object xml: x-add-datatype: true vesselphoto-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/vesselphoto-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vesselphoto-response-listing-vessel: properties: image_url: format: ascii type: string xml: x-add-datatype: true required: - image_url title: vessel type: object xml: name: vessel x-add-datatype: true vesselportcall-response-listing: properties: portcalls: items: $ref: '#/definitions/vesselportcall-response-listing-portcall' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - portcalls type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vesselportcall-response-listing-portcall: properties: ata: description: actual time of arrival format: date-time type: string xml: x-add-datatype: true atd: description: actual time of departure, if `null` the portcall is ongoing format: date-time type: string x-nullable: true xml: x-add-datatype: true cn_iso2: description: port country name type: string xml: x-add-datatype: true cn_name: description: port country ISO-alpha-2 code type: string xml: x-add-datatype: true latitude: format: float type: number xml: x-add-datatype: true locode: description: port UN/LOCODE format: ascii type: string x-nullable: true xml: x-add-datatype: true longitude: format: float type: number xml: x-add-datatype: true name: description: port name type: string xml: x-add-datatype: true required: - atd - name - ata - longitude - cn_iso2 - cn_name - latitude - locode title: portcall type: object xml: name: portcall x-add-datatype: true vessels_near_position: items: $ref: '#/definitions/vessels_near_position-item' properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer required: - used_requests title: request-limit-info type: object title: vessels_near_position type: array xml: name: response namespace: https://apiv2.fleetmon.com wrapped: true x-extra-attributes: timestamp: type: date-time vessels_near_position-item: properties: course_over_ground: description: Latest course over ground via AIS (position message) in degree format: int64 type: number x-nullable: true xml: x-add-datatype: true distance_to_vessel: description: Distance from vessel to requested vessel in meter format: int64 type: integer x-nullable: false xml: x-add-datatype: true latitude: description: Latitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: false xml: x-add-datatype: true name: description: Vessel name by FleetMon type: string x-nullable: true xml: x-add-datatype: true nav_status: description: Latest navigation status reported via AIS (position message) type: string xml: x-add-datatype: true received: description: Latest position received in Zulu time format from AIS (position message) format: date-time type: string x-nullable: false xml: x-add-datatype: true speed: description: Latest speed received via AIS (position message) in knots format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: Latest true heading of keel (hull) via AIS (position message) in degree format: float type: number x-nullable: true xml: x-add-datatype: true type_class: description: Vessel class sent by AIS type: string x-nullable: true xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: number x-nullable: true xml: x-add-datatype: true required: - latitude - longitude - mmsi - received title: vessels_near_position type: object xml: name: item x-add-datatype: true vessels_nearby: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessel_of_interrest: $ref: '#/definitions/vessels_nearby-vessel_of_interrest_response' description: AIS information for requested vessel x-nullable: false vessels_nearby: items: $ref: '#/definitions/vessels_nearby-vessels_nearby_response' description: AIS information for vessels nearby requested vessel x-nullable: false type: array xml: wrapped: true x-add-datatype: true required: - vessel_of_interrest - vessels_nearby title: vessels_nearby_response type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vessels_nearby-vessel_of_interrest_response: description: AIS information for requested vessel properties: course_over_ground: description: Latest course over ground via AIS (position message) in degree format: int64 type: number x-nullable: true xml: x-add-datatype: true latitude: description: Latitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true length: description: Length sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: false xml: x-add-datatype: true name: description: Vessel name by FleetMon type: string x-nullable: true xml: x-add-datatype: true nav_status: description: Latest navigation status reported via AIS (position message) type: string xml: x-add-datatype: true received: description: Latest position received in Zulu time format from AIS (position message) format: date-time type: string x-nullable: false xml: x-add-datatype: true speed: description: Latest speed received via AIS (position message) in knots format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: Latest true heading of keel (hull) via AIS (position message) in degree format: float type: number x-nullable: true xml: x-add-datatype: true type_class: description: Vessel class sent by AIS type: string x-nullable: true xml: x-add-datatype: true width: description: Width sent by vessel format: int64 type: number x-nullable: true xml: x-add-datatype: true required: - latitude - longitude - mmsi - received title: vessel_of_interrest type: object x-nullable: false xml: name: vessel_of_interrest_response x-add-datatype: true vessels_nearby-vessels_nearby_response: description: AIS information for vessels near requested vessel properties: course_over_ground: description: Latest course over ground via AIS (position message) in degree format: int64 type: number x-nullable: true xml: x-add-datatype: true distance_to_vessel: description: Distance from vessel to requested vessel in meter format: int64 type: integer x-nullable: false xml: x-add-datatype: true latitude: description: Latitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude share of latest position reported by AIS (position message) format: float type: number x-nullable: false xml: x-add-datatype: true mmsi: description: MMSI sent by vessel format: int64 type: number x-nullable: false xml: x-add-datatype: true name: description: Vessel name by FleetMon type: string x-nullable: true xml: x-add-datatype: true nav_status: description: Latest navigation status reported via AIS (position message) type: string xml: x-add-datatype: true received: description: Latest position received in Zulu time format from AIS (position message) format: date-time type: string x-nullable: false xml: x-add-datatype: true speed: description: Latest speed received via AIS (position message) in knots format: float type: number x-nullable: true xml: x-add-datatype: true true_heading: description: Latest true heading of keel (hull) via AIS (position message) in degree format: float type: number x-nullable: true xml: x-add-datatype: true type_class: description: Vessel class sent by AIS type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: number x-nullable: true xml: x-add-datatype: true width: description: width of vessel in meter via AIS (static message) format: int64 type: number x-nullable: true xml: x-add-datatype: true required: - vessel_id - distance_to_vessel - latitude - longitude - mmsi - received title: vessels_nearby type: object x-nullable: false xml: name: vessels_nearby_response x-add-datatype: true vesselsearch-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true vessels: items: $ref: '#/definitions/vesselsearch-response-listing-vessel' type: array xml: wrapped: true x-add-datatype: true required: - vessels type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time vesselsearch-response-listing-vessel: properties: callsign: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_iso2: format: ascii type: string x-nullable: true xml: x-add-datatype: true cn_name: type: string x-nullable: true xml: x-add-datatype: true imo_number: description: unique International Maritime Organization (IMO) vessel number format: int64 type: integer x-nullable: true xml: x-add-datatype: true length: description: length of vessel in meter via AIS (static message) format: int64 type: integer x-nullable: true xml: x-add-datatype: true mmsi_number: description: 9 decimal digits Maritime Mobile Service Identity (connector between AIS message typs) format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true position_received: description: time of received position message format: date-time type: string x-nullable: true xml: x-add-datatype: true static_received: description: time of received static message format: date-time type: string xml: x-add-datatype: true vessel_id: description: FleetMon identifier for maritime objects like vessels format: int64 type: integer xml: x-add-datatype: true vt_verbose: type: string x-nullable: true xml: x-add-datatype: true required: - static_received - name - imo_number - length - mmsi_number - cn_iso2 - callsign - vt_verbose - cn_name - position_received - vessel_id title: vessel type: object xml: name: vessel x-add-datatype: true voyage_planning-request: properties: start: description: Start time of voyage (ETD of first stop; if not included the current vessel position and distance to first stop is considered) format: date-time type: string xml: x-add-datatype: true stops: items: $ref: '#/definitions/voyage_planning-request-stop' minLength: 1 type: array xml: wrapped: true x-add-datatype: true vessel_id: description: Vessel ID format: int64 type: integer xml: x-add-datatype: true required: - vessel_id - stops type: object xml: name: voyage_planning_request namespace: https://apiv2.fleetmon.com voyage_planning-request-stop: properties: laytime: description: laytime in minutes in port, may be omitted in last entry format: int64 type: integer xml: x-add-datatype: true locode: description: LOCODE of destination port maxLength: 5 minLength: 5 type: string xml: x-add-datatype: true roadstead: description: roadstead laytime in hours before entering the port, defaults to `0` format: int64 type: integer xml: x-add-datatype: true required: - locode - laytime type: object xml: name: item x-add-datatype: true voyage_planning-response: properties: callsign: description: Vessel Callsign type: string x-nullable: true xml: x-add-datatype: true imo_number: description: Vessel IMO number format: int64 type: integer x-nullable: true xml: x-add-datatype: true latitude: description: Vessels current Latitude format: float type: number xml: x-add-datatype: true longitude: description: Vessels current Longitude format: float type: number xml: x-add-datatype: true mmsi_number: description: Vessel MMSI number format: int64 type: integer x-nullable: true xml: x-add-datatype: true name: description: Vessel Name type: string x-nullable: true xml: x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true stops: items: $ref: '#/definitions/voyage_planning-response-stop' type: array xml: wrapped: true x-add-datatype: true vessel_id: description: Vessel ID format: int64 type: integer xml: x-add-datatype: true required: - vessel_id - name - imo_number - mmsi_number - callsign - latitude - longitude - stops type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time voyage_planning-response-stop: properties: distance: description: Travel distance to port in nautical miles format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: Estimated time of arrival at port format: date-time type: string x-nullable: true xml: x-add-datatype: true etd: description: Estimated time of departure from port format: date-time type: string x-nullable: true xml: x-add-datatype: true message: description: Contains a description if port or route can not be found, `eta`, `etd` & `distance` will be `null` in that case. type: string xml: x-add-datatype: true port_locode: description: LOCODE of port type: string xml: x-add-datatype: true port_name: description: Name of port type: string xml: x-add-datatype: true required: - eta - etd - distance type: object xml: name: item x-add-datatype: true zone-response-listing: properties: request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests title: request-limit-info type: object xml: x-add-datatype: true zones: items: $ref: '#/definitions/zone-response-listing-zone' type: array xml: wrapped: true x-add-datatype: true required: - zones type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time zone-response-listing-zone: properties: lat: format: float type: number xml: x-add-datatype: true locodes: items: type: string xml: name: item x-add-datatype: true type: array xml: wrapped: true x-add-datatype: true lon: format: float type: number xml: x-add-datatype: true name: type: string x-nullable: true xml: x-add-datatype: true related_ports: items: $ref: '#/definitions/zone-response-listing-zone-related_ports' type: array xml: wrapped: true x-add-datatype: true status: type: string xml: x-add-datatype: true type: $ref: '#/definitions/zone-response-listing-zone-type' zone_id: format: int64 type: integer xml: x-add-datatype: true required: - status - name - related_ports - lon - lat - locodes - type - zone_id title: zone type: object xml: name: zone x-add-datatype: true zone-response-listing-zone-related_ports: properties: cn_iso2: type: string x-nullable: true xml: x-add-datatype: true locode: type: string xml: x-add-datatype: true name: type: string xml: x-add-datatype: true port_id: format: int64 type: integer xml: x-add-datatype: true required: - cn_iso2 - port_id - name - locode title: ports type: object xml: name: port x-add-datatype: true zone-response-listing-zone-type: properties: code: type: string x-nullable: true xml: x-add-datatype: true color: type: string x-nullable: true xml: x-add-datatype: true main_group: type: string xml: x-add-datatype: true sub_group: type: string xml: x-add-datatype: true verbose: type: string xml: x-add-datatype: true required: - sub_group - verbose - color - code - main_group title: zone-type type: object xml: x-add-datatype: true zone_call: properties: duration: description: terminal call duration in seconds type: integer xml: x-add-datatype: true entered_event: $ref: '#/definitions/zone_call-event' id: description: unique call id type: string xml: x-add-datatype: true left_event: $ref: '#/definitions/zone_call-event' vessel: $ref: '#/definitions/zone_call-vessel' zone: $ref: '#/definitions/zone_call-zone' required: - id - vessel - zone - entered_event type: object xml: name: item x-add-datatype: true zone_call-event: description: zone event properties: destination: description: Vessel's destination, when event occured type: string x-nullable: true xml: x-add-datatype: true draught: description: Vessel' draught, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true eta: description: Vessel's ETA, when event occured format: date-time type: string x-nullable: true xml: x-add-datatype: true latitude: description: Latitude of vessel position, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true longitude: description: Longitude of vessel position, when event occured format: float type: number x-nullable: true xml: x-add-datatype: true timestamp: format: date-time type: string xml: x-add-datatype: true required: - timestamp - draught - eta - destination - latitude - longitude type: object xml: x-add-datatype: true zone_call-response-listing: properties: calls: items: $ref: '#/definitions/zone_call' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to listing URL of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to listing URL of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to listing URL of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - calls type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time zone_call-response-zone_calls: properties: calls: items: $ref: '#/definitions/zone_call' type: array xml: wrapped: true x-add-datatype: true request_limit_info: description: Information about usage and limits of this endpoint. Included if query parameter `request_limit_info` is `true` properties: left_requests: description: Number of requests left at this moment to detail URLs of this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true left_requests_overall: description: Number of requests left at this moment to this endpoint. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests: description: Maximum number of requests to detail URLs of this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true max_requests_overall: description: Maximum number of requests to this endpoint within 30 days. If not included there is no limit. type: integer xml: x-add-datatype: true used_requests: description: Number of requests to detail URLs of this endpoint within the last 30 days. type: integer xml: x-add-datatype: true used_requests_overall: description: Number of requests to this endpoint within the last 30 days. type: integer xml: x-add-datatype: true required: - used_requests_overall - used_requests title: request-limit-info type: object xml: x-add-datatype: true required: - calls type: object xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time zone_call-vessel: description: vessel object properties: callsign: description: vessel callsign type: string x-nullable: true xml: x-add-datatype: true imo: description: vessel imo number format: int64 type: integer x-nullable: true xml: x-add-datatype: true length: description: vessel length format: float type: number x-nullable: true xml: x-add-datatype: true mmsi: description: vessel mmsi number format: int64 type: integer xml: x-add-datatype: true name: description: vessel name type: string x-nullable: true xml: x-add-datatype: true vessel_id: description: vessel id format: int64 type: integer xml: x-add-datatype: true width: description: vessel width format: float type: number x-nullable: true xml: x-add-datatype: true required: - vessel_id - mmsi - imo - name - callsign - length - width type: object xml: x-add-datatype: true zone_call-zone: description: zone object properties: latitude: description: zone area centroid latitude format: float type: number xml: x-add-datatype: true location_description: description: zone location description type: string x-nullable: true xml: x-add-datatype: true longitude: description: zone area centroid longitude format: float type: number xml: x-add-datatype: true name: description: zone name type: string xml: x-add-datatype: true port_name: description: associated port name type: string x-nullable: true xml: x-add-datatype: true zone_id: description: zone id format: int64 type: integer xml: x-add-datatype: true required: - zone_id - latitude - longitude - name - location_description - port_name type: object xml: x-add-datatype: true host: apiv2.fleetmon.com info: description: 'ARCHIVED SPECIFICATION - RETIRED API. This is the final publicly archived Swagger 2.0 definition of the FleetMon API (apiv2.fleetmon.com), preserved from the Internet Archive Wayback Machine (schema.json capture 2021-12-08; the developer portal at developer.fleetmon.com remained online through early 2025). FleetMon was acquired by Kpler in 2023, the FleetMon platform and API were phased out beginning January 2024 and migrated into MarineTraffic, and as of 2026 the fleetmon.com domain (including apiv2.fleetmon.com and developer.fleetmon.com) no longer resolves. None of the endpoints below are live. The successor surface is the MarineTraffic API portfolio / Kpler AIS (servicedocs.marinetraffic.com). --- Original description follows --- Welcome to our API reference! You can view JSON response samples in the area to the right. If you need help with the API, just [contact us](https://www.fleetmon.com/company/contact/). Follow us on [Facebook](https://www.facebook.com/fleetmon) and [Twitter](https://twitter.com/fleetmon) for the latest updates and news on the platform. With the use of the FleetMon API, you agree with the [Terms of Service](https://www.fleetmon.com/terms-of-service/). ' title: FleetMon API Reference version: Version 2.4.2 x-archived: status: retired retiredNote: FleetMon product offerings, logins, and the apiv2.fleetmon.com API were discontinued during the 2024 migration into MarineTraffic following the 2023 Kpler acquisition; fleetmon.com DNS no longer resolves as of 2026. archiveSource: http://web.archive.org/web/20211208160310/https://apiv2.fleetmon.com/schema.json archivedDeveloperPortal: http://web.archive.org/web/20250106234623/https://developer.fleetmon.com/reference/ successor: https://servicedocs.marinetraffic.com/ archivedBy: API Evangelist archivedDate: '2026-07-11' paths: /ais/position/: get: description: '' operationId: get-ais_position-listing parameters: - description: start time for track format: date-time in: query name: from required: false type: string - description: maximum number of messages to return format: int64 in: query name: limit required: false type: integer - description: MMSI number format: int64 in: query name: mmsi required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: asc description: sorting of items enum: - asc - desc format: ascii in: query name: sort required: false type: string - description: resolution of track in seconds format: int64 in: query name: time_res required: false type: integer - description: end time for track format: date-time in: query name: until required: false type: string responses: '200': description: Historical Track API - get ais position items response schema: $ref: '#/definitions/ais_position-response' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: 'Returns historical AIS position reports with fixed period and rate. Input: MMSI' tags: - Historical Track API /ais/static/: get: description: '' operationId: get-ais_static-listing parameters: - description: start time for messages format: date-time in: query name: from required: false type: string - description: maximum number of messages to return format: int64 in: query name: limit required: false type: integer - description: MMSI number format: int64 in: query name: mmsi required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: asc description: sorting of items enum: - asc - desc format: ascii in: query name: sort required: false type: string - description: end time for messages format: date-time in: query name: until required: false type: string responses: '200': description: Historical AIS Static Messages - get ais static items response schema: $ref: '#/definitions/ais_static-response' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: AIS static and voyage related data reports tags: - Historical AIS Static Messages /basicvessel/{vessel_id}: get: description: '' operationId: get-vesselbasic-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Basic Vessel Data - vessel response schema: $ref: '#/definitions/vesselbasic-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers basic static data for a vessel. tags: - Basic Vessel Data /distance/to/port/{to_port}: get: description: '' operationId: get-distancetoport-detail parameters: - description: Destination Port (expected FleetMon PortID ) format: int64 in: path name: to_port required: true type: integer - description: 'Draught of vessel in meters (default: 1.0)' format: float in: query name: draught required: false type: number - description: Start coordinates, two floats seperated with comma (54.875,12.305) in: query name: from_latlon required: false type: string - description: Start Port (expected FleetMon PortID ) format: int64 in: query name: from_port required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'Speed of vessel in knots (default: 20.0)' format: float in: query name: speed required: false type: number responses: '200': description: Distance To Port Response schema: $ref: '#/definitions/geo_distance-to-port' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns a summary of the calculated route to the given port tags: - Distance To Port /fleet/: delete: description: '' operationId: delete-fleet-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean responses: '200': description: Fleet Tracker - clear vessels response schema: $ref: '#/definitions/fleet-response-delete' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Empties the fleet completely. tags: - Fleet Tracker get: description: '' operationId: get-fleet-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean - description: optional filter by tag name in: query name: tag required: false type: string responses: '200': description: Fleet Tracker - vessels response schema: $ref: '#/definitions/fleet-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the fleet. tags: - Fleet Tracker post: description: '' operationId: post-fleet-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean - description: Fleet Tracker - replace vessels request in: body name: fleet-listing-replace required: true schema: $ref: '#/definitions/fleet-listing-replace' responses: '200': description: Fleet Tracker - replace vessels response schema: $ref: '#/definitions/fleet-response-listing-replace' '400': description: The request body could not be parsed. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-400 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 400 description: You sent a request that this server could not understand. message: Bad Request status: error '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Replaces the fleet with new vessels. tags: - Fleet Tracker put: description: '' operationId: put-fleet-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean - description: Fleet Tracker - add vessels request in: body name: fleet-listing-add required: true schema: $ref: '#/definitions/fleet-listing-add' responses: '200': description: Fleet Tracker - add vessels response schema: $ref: '#/definitions/fleet-response-listing-add' '400': description: The request body could not be parsed. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-400 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 400 description: You sent a request that this server could not understand. message: Bad Request status: error '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Adds vessels to the fleet. tags: - Fleet Tracker /fleet/{vessel_id}: delete: description: '' operationId: delete-fleet-detail parameters: - description: vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean responses: '200': description: Fleet Tracker - remove vessel response schema: $ref: '#/definitions/fleet-response-delete' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Removes a single vessel from the fleet. tags: - Fleet Tracker get: description: '' operationId: get-fleet-detail parameters: - description: vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean responses: '200': description: Fleet Tracker - vessel response schema: $ref: '#/definitions/fleet-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers a single vessel from the fleet. tags: - Fleet Tracker put: description: '' operationId: put-fleet-detail parameters: - description: vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: size_limit_info required: false type: boolean - description: Fleet Tracker - edit vessel request in: body name: fleet-request-edit-vessel required: true schema: $ref: '#/definitions/fleet-request-edit-vessel' responses: '200': description: Fleet Tracker - edit vessel response schema: $ref: '#/definitions/fleet-response-edit' '400': description: The request body could not be parsed. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-400 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 400 description: You sent a request that this server could not understand. message: Bad Request status: error '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Modifies custom attributes of a single vessel. tags: - Fleet Tracker /lng_vessel/events/: get: description: '' operationId: get-lng_vessel_events-listing parameters: - default: EtaChanged description: Type of event that should be delivered enum: - DestinationChanged - EtaChanged format: ascii in: query name: event_type required: true type: string - description: 'Start of requested time interval (default: `until` - 1d)' format: date-time in: query name: from required: false type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'End of requested time interval (default: `now`)' format: date-time in: query name: until required: false type: string responses: '200': description: Vessel ETA & Destination Change Events - get events response schema: $ref: '#/definitions/lng_vessel_events-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers ETA & Destination Changes for vessels. tags: - Vessel ETA & Destination Change Events /lng_vessel/events/{vessel_id}: get: description: '' operationId: get-lng_vessel_events-detail parameters: - description: ID of vessel to get events for format: int64 in: path name: vessel_id required: true type: integer - default: EtaChanged description: Type of event that should be delivered enum: - DestinationChanged - EtaChanged format: ascii in: query name: event_type required: true type: string - description: 'Start of requested time interval (default: `until` - 1d)' format: date-time in: query name: from required: false type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'End of requested time interval (default: `now`)' format: date-time in: query name: until required: false type: string responses: '200': description: Vessel ETA & Destination Change Events - get event response schema: $ref: '#/definitions/lng_vessel_events-response-listing-single' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers ETA & Destination Changes for a single vessel. tags: - Vessel ETA & Destination Change Events /logistics/vessel/{vessel_id}: get: description: '' operationId: get-logistics_vessel-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Logistics - vessel response schema: $ref: '#/definitions/logistics_vessel-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers information about the vessels current state and the next port it is heading for tags: - Logistics /meteo/current/: get: description: '' operationId: get-meteo_current-listing parameters: - default: 0.0 description: Latitude for forecast format: float in: query name: lat required: false type: number - default: 0.0 description: Longitude for forecast format: float in: query name: lon required: false type: number - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Time for forecast, defaults to `now` format: date-time in: query name: when required: false type: string responses: '200': description: Current - get current-reports response schema: $ref: '#/definitions/meteo_current-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns current info for lat/lon (and timestamp). tags: - Current /meteo/current/{gxi}/{tb}/{gyi}: get: description: '' operationId: get-meteo_current-detail parameters: - description: grid-coordinate x format: int64 in: path name: gxi required: true type: integer - description: grid-coordinate y format: int64 in: path name: gyi required: true type: integer - description: 3h-timeblock format: int64 in: path name: tb required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Current - get current-report response schema: $ref: '#/definitions/meteo_current-response-current-report' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns current info for grid coordinates xi and yi (and timeblock). tags: - Current /meteo/wave/: get: description: '' operationId: get-meteo_wave-listing parameters: - default: 0.0 description: Latitude for forecast format: float in: query name: lat required: false type: number - default: 0.0 description: Longitude for forecast format: float in: query name: lon required: false type: number - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Time for forecast, defaults to `now` format: date-time in: query name: when required: false type: string responses: '200': description: Water - get wave-reports response schema: $ref: '#/definitions/meteo_wave-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns wave info for lat/lon (and timestamp). tags: - Water /meteo/wave/{geohash}: get: description: '' operationId: get-meteo_wave-detail parameters: - description: Location as geohash (level 5) in: path name: geohash required: true type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Time for forecast, defaults to `now` format: date-time in: query name: when required: false type: string responses: '200': description: Water - get wave-report response schema: $ref: '#/definitions/meteo_wave-response-wave-report' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns wave info for Geohash level 5 (and timestamp). tags: - Water /meteo/weather/: get: description: '' operationId: get-meteo_weather-listing parameters: - default: 0.0 description: Latitude for forecast format: float in: query name: lat required: false type: number - default: 0.0 description: Longitude for forecast format: float in: query name: lon required: false type: number - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Time for forecast, defaults to `now` format: date-time in: query name: when required: false type: string responses: '200': description: Weather - get weather-reports response schema: $ref: '#/definitions/meteo_weather-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns weather info for lat/lon (and timestamp). tags: - Weather /meteo/weather/{geohash}: get: description: '' operationId: get-meteo_weather-detail parameters: - description: Location as geohash (level 5) in: path name: geohash required: true type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Time for forecast, defaults to `now` format: date-time in: query name: when required: false type: string responses: '200': description: Weather - get weather-report response schema: $ref: '#/definitions/meteo_weather-response-weather-report' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns weather info for Geohash level 5 (and timestamp). tags: - Weather /my/user-login-token/: get: description: '' operationId: get-user_login_api-detail parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: Token Key for associated User in: query name: token-key required: true type: string responses: '200': description: Get user Login token for token key schema: $ref: '#/definitions/get-user-login-token' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: [] summary: '' tags: - Login Token /myfleet/: get: description: '' operationId: get-myfleet-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: My Fleet Positions - vessels response schema: $ref: '#/definitions/myfleet-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers your MyFleet. tags: - My Fleet Positions /myfleet/{vessel_id}: get: description: '' operationId: get-myfleet-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: My Fleet Positions - vessel response schema: $ref: '#/definitions/myfleet-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers a single vessel of your MyFleet. tags: - My Fleet Positions /port/arrivals/: get: description: '' operationId: get-port_arrivals-listing parameters: - description: UN/LOCODE for the port to lookup format: ascii in: query name: locode required: true type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: optional vessel coarse type for filtering the result set in: query name: type_coarse required: false type: string - description: optional vessel type code for filtering the result set in: query name: type_code required: false type: string responses: '200': description: Expected Port Arrivals - vessels response schema: $ref: '#/definitions/port_arrivals-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the list of vessels. tags: - Expected Port Arrivals /port/inport/: get: description: '' operationId: get-port_inport-listing parameters: - description: UN/LOCODE for the port to lookup format: ascii in: query name: locode required: true type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: optional vessel coarse type for filtering the result set in: query name: type_coarse required: false type: string - description: optional vessel type code for filtering the result set in: query name: type_code required: false type: string responses: '200': description: Vessels in Port - vessels response schema: $ref: '#/definitions/port_inport-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the list of vessels tags: - Vessels in Port /port/portcalls/: get: description: '' operationId: get-portportcall-listing parameters: - description: UN/LOCODE for the port to lookup format: ascii in: query name: locode required: true type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: optional vessel coarse type for filtering the result set in: query name: type_coarse required: false type: string - description: optional vessel type code for filtering the result set in: query name: type_code required: false type: string responses: '200': description: Port Calls per Port - portcalls response schema: $ref: '#/definitions/portportcall-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers portcalls for a port tags: - Port Calls per Port /portsearch/: get: description: '' operationId: get-portsearch-listing parameters: - description: countries ISO-alpha-2 code, only exact matching, 2 letters in: query name: cn_iso2 required: false type: string - description: UN/LOCODE, only exact matching, 5 letters in: query name: locode required: false type: string - description: sub-string matching, minium length is 3 characters in: query name: name required: false type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Port Search - ports response schema: $ref: '#/definitions/portsearch-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the list of ports that matched the criteria tags: - Port Search /regional_ais/: get: description: '' operationId: get-regional_ais-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Regional AIS - vessels response schema: $ref: '#/definitions/regional_ais-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the list of vessels inside the bounding box tags: - Regional AIS /terminal/call/demo/: get: description: '' operationId: get-terminal_call_demo-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: RoRo Ferry Terminal Demo - get calls response schema: $ref: '#/definitions/terminal_call_demo-response-calls' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: [] summary: Delivers a list of terminal calls tags: - RoRo Ferry Terminal Demo /vessel/events/{vessel_id}: get: description: '' operationId: get-vessel_events-detail parameters: - description: ID of vessel to get events for format: int64 in: path name: vessel_id required: true type: integer - description: Type of event that should be delivered enum: - CallsignChanged - DestinationChanged - DraughtChanged - EtaChanged - IMOChanged - LengthChanged - MMSIChanged - NameChanged - NavStatusChanged - ReceiverPositionAChanged - ReceiverPositionBChanged - ReceiverPositionCChanged - ReceiverPositionDChanged - SpecialCargoChanged - VesselTypeChanged - WidthChanged in: query name: event_type required: false type: string - description: 'End of requested time interval (default: `until` - 1d)' format: date-time in: query name: from required: false type: string - default: -5 description: Limit number of results, <0 means descending order, >0 means ascending order format: int64 in: query name: limit required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'Start of requested time interval (default: now)' format: date-time in: query name: until required: false type: string responses: '200': description: Vessel Change Events - get event response schema: $ref: '#/definitions/vessel_events-response-listing-single' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers change events for a vessels. tags: - Vessel Change Events /vessel/near/: get: description: '' operationId: get-vessels_near_position-detail parameters: - description: Latitude in decimal notation for requested position format: float in: query name: lat required: true type: number - description: Longitude in decimal notation for requested position format: float in: query name: lon required: true type: number - description: Radius around the requested vessel in meter. Default and maximum radius is 2500 meter. format: int64 in: query name: radius required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessels near position schema: $ref: '#/definitions/vessels_near_position' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: '' tags: - Vessels Near Position /vessel/photo/{size}/: get: description: '' operationId: get-vesselphoto-listing parameters: - description: sizing for photo enum: - thumbnail - standard - large in: path name: size required: true type: string - description: only exact matching format: int64 in: query name: imo_number required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: master description: photo version enum: - most_recent - most_voted - master in: query name: version required: false type: string - description: only exact matching format: int64 in: query name: vessel_id required: false type: integer responses: '200': description: Vessel Photo - vessels response schema: $ref: '#/definitions/vesselphoto-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: URL to main photo for a vessel in specified size tags: - Vessel Photo /vessel/portcalls/: get: description: '' operationId: get-vesselportcall-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - format: int64 in: query name: vessel_id required: true type: integer responses: '200': description: Port Calls per Vessel - portcalls response schema: $ref: '#/definitions/vesselportcall-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers portcalls for a vessel tags: - Port Calls per Vessel /vessel/{vessel_id}: get: description: '' operationId: get-vesselparticulars-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Positions with Extended Vessel Data - vessel response schema: $ref: '#/definitions/vesselparticulars-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers extended information for a vessel tags: - Vessel Positions with Extended Vessel Data /vessel/{vessel_id}/ais/dynamic/: get: description: '' operationId: get-vessel_dynamic_ais-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Dynamic AIS schema: $ref: '#/definitions/vessel-dynamic-ais' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: '' tags: - Vessel Dynamic AIS /vessel/{vessel_id}/identity/: get: description: Returns the identifying attributes of the provided vessel including name, IMO, MMSI, Callsign and ENI. operationId: get-vessel-identity-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Identity schema: $ref: '#/definitions/vessel-identity' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns the identifying attributes of the provided vessel. tags: - Vessel Identity /vessel/{vessel_id}/nearby/: get: description: '' operationId: get-vessels_nearby-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - description: Radius around the requested vessel in meter. Default and maximum radius is 2500 meter. format: int64 in: query name: radius required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessels nearby schema: $ref: '#/definitions/vessels_nearby' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: '' tags: - Vessels Nearby /vessel/{vessel_id}/port/{port_id}/laytime/: get: description: '' operationId: get-vessellaytime-listing parameters: - description: FleetMon Port ID format: int64 in: path name: port_id required: true type: integer - description: FleetMon Vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: '365' description: Lookback time to calculate laytimes in days enum: - '90' - '365' - '1095' format: int64 in: query name: lookback required: false type: integer - default: '60' description: Minimum duration of vessel staying in the terminal. enum: - '5' - '60' - '3600' format: int64 in: query name: minimum_laytime required: false type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Laytime schema: $ref: '#/definitions/vessel-laytime' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Estimated laytime for vessel tags: - Estimated Laytime - Specific Vessel /vessel/{vessel_id}/ports/next/: get: description: Delivers information about the next port given by a vessels AIS data. operationId: get-next_port-detail parameters: - description: FleetMon Vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Next Port schema: $ref: '#/definitions/next-port' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Next Port tags: - Next Port / ETA Calculation /vessel/{vessel_id}/position/: get: description: This API returns the latest position of the provided vessel including MMSI, longitude, latitude and received time in Zulu format. operationId: get-vessel-position-only-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Position Only schema: $ref: '#/definitions/vessel-position-only' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Returns the latest position of the provided vessel tags: - Vessel Positions Only /vessel/{vessel_id}/route/port/last/: get: description: Returns the actual route from last port to latest position. operationId: get-vessel_route_from_last_port-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Route From Last Port Response schema: $ref: '#/definitions/vessel_route_from_last_port' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Vessel Route From Last Port tags: - Vessel Route From Last Port /vessel/{vessel_id}/route/port/next/: get: description: Returns the route to the next port of a provided FleetMon vessel identifier. operationId: get-vessel_route_to_next_port-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - description: 'Draught of vessel in meters (default: latest reported draught from vessel or 1 if draught is unavailable or 0)' format: float in: query name: draught required: false type: number - description: 'Minimum draught of vessel in meters (default: minimum reported draught from vessel or 1 if draught is unavailable or 0)' format: float in: query name: min_draught required: false type: number - description: 'Minimum speed of vessel in knots (default: average vessel speed or 20 if speed is unavailble or 0)' format: float in: query name: min_speed required: false type: number - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'Speed of vessel in knots (default: latest resported speed from vessel or 20 if speed is unavailble or 0)' format: float in: query name: speed required: false type: number responses: '200': description: Vessel Route To Next Port Response schema: $ref: '#/definitions/vessel_route_to_next_port' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Fetch route to next port for provided vessel. tags: - Vessel Route To Next Port /vessel/{vessel_id}/schedule/: get: description: '' operationId: get-vesselschedule-listing parameters: - description: FleetMon Vessel ID format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Vessel Schedule schema: $ref: '#/definitions/vessel-schedule' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Schedules for vessel tags: - Vessel Schedule /vessel_nonais/{vessel_id}: get: description: '' operationId: get-nonaisparticulars-detail parameters: - description: FleetMon identifier for maritime objects like vessels format: int64 in: path name: vessel_id required: true type: integer - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Non AIS Vessel Particulars - vessel response schema: $ref: '#/definitions/nonaisparticulars-response-vessel' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers non-AIS information for a vessel tags: - Non AIS Vessel Particulars /vesselsearch/: get: description: '' operationId: get-vesselsearch-listing parameters: - description: only exact matching in: query name: callsign required: false type: string - description: only exact matching format: int64 in: query name: eni_number required: false type: integer - description: only exact matching format: int64 in: query name: imo_number required: false type: integer - description: maximum timespan of last received position signal, in days format: int64 in: query name: max_pos_age_days required: false type: integer - description: only exact matching format: int64 in: query name: mmsi_number required: false type: integer - description: sub-string matching, minium length is 3 characters in: query name: name required: false type: string - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - default: true description: request only vessels with a valid position in: query name: with_position required: false type: boolean responses: '200': description: Vessel Search - vessels response schema: $ref: '#/definitions/vesselsearch-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers the list of vessels that matched the criteria. tags: - Vessel Search /voyage-planning/: post: description: It is possible to specify multiple stops by LOCODE together with roadstead time and laytime. operationId: post-voyage_planning-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: List of port stops for the voyage. in: body name: voyage_planning-request required: true schema: $ref: '#/definitions/voyage_planning-request' responses: '200': description: Voayage Planning Response schema: $ref: '#/definitions/voyage_planning-response' '400': description: The request body could not be parsed. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-400 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 400 description: You sent a request that this server could not understand. message: Bad Request status: error '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers ETA & distance estimations for a voyage tags: - Voyage Planning /zone/: get: description: '' operationId: get-zone-listing parameters: - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean responses: '200': description: Zone Information - zones response schema: $ref: '#/definitions/zone-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers a listing of your configured zones with some extra information. tags: - Zone Information /zone/calls/: get: description: "Delivers a list of call items for your zones. Each call contains zone information,\ \ vessel information, entered event and left event.\r\nThe events contain latitude, longitude,\ \ draft, destination and ETA at the time of entry/leaving.\r\nIt is possible to specify the time\ \ frame and whether to include closed and/or open calls." operationId: get-zone_call-listing parameters: - default: true description: Include closed zone calls in: query name: closed required: false type: boolean - default: 3600 description: Collect subsequent calls into one, when `departure` - `arrival` < `collect_time` format: int64 in: query name: collect_time required: false type: integer - default: 0 description: Minimun duration of call, Shorter calls will be discarded format: int64 in: query name: duration_min required: false type: integer - description: 'Start of requested time interval (default: `until` - 1d)' format: date-time in: query name: from required: false type: string - default: false description: Include open zone calls in: query name: open required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'End of requested time interval (default: now)' format: date-time in: query name: until required: false type: string - description: ID of zone to get calls for format: int64 in: query name: zone_id required: false type: integer responses: '200': description: Zone Call - get zone call response schema: $ref: '#/definitions/zone_call-response-listing' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers a list of call items tags: - Zone Call /zone/calls/{zone_id}: get: description: "Delivers a list of call items for one of your zones. Each call contains zone information,\ \ basic vessel information, entered event and left event.\r\nThe events contain latitude, longitude,\ \ draft, destination and ETA at the time of entry/leaving.\r\nIt is possible to specify the time\ \ frame and whether to include closed and/or open calls." operationId: get-zone_call-detail parameters: - description: ID of zone to get calls for format: int64 in: path name: zone_id required: true type: integer - default: true description: Include closed zone calls in: query name: closed required: false type: boolean - default: 3600 description: Collect subsequent calls into one, when `departure` - `arrival` < `collect_time` format: int64 in: query name: collect_time required: false type: integer - default: 0 description: Minimun duration of call, Shorter calls will be discarded format: int64 in: query name: duration_min required: false type: integer - description: 'Start of requested time interval (default: `until` - 1d)' format: date-time in: query name: from required: false type: string - default: false description: Include open zone calls in: query name: open required: false type: boolean - default: false description: If `true` some extra attributes will be added to the response informing about usage and limits of this endpoint. in: query name: request_limit_info required: false type: boolean - description: 'End of requested time interval (default: now)' format: date-time in: query name: until required: false type: string - description: ID of zone to get calls for format: int64 in: query name: zone_id required: false type: integer responses: '200': description: Zone Call - get zone calls response schema: $ref: '#/definitions/zone_call-response-zone_calls' '401': description: The server could not verify that you are authorized to access the URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-401 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 401 description: The server could not verify that you are authorized to access the URL requested. message: Unauthorized status: error '403': description: The provided credentials were correct but the API is not yet fully configured. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-403 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 403 description: The API is not yet fully configured. message: Forbidden status: error '404': description: Requested item does not exist. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-404 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 404 description: The requested item was not found on the server. message: Not Found status: error '405': description: The used HTTP method is not allowed for this URL. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-405 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 405 description: The method is not allowed for the requested URL. message: Method Not Allowed status: error '422': description: A required parameter is missing or has a wrong structure. schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-422 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 422 description: The request was well-formed but was unable to be followed due to semantic errors. message: Unprocessable Entity status: error '429': description: The client requested the resource too many times. (rate limit) schema: allOf: - $ref: '#/definitions/error-message-response' - title: response-status-429 xml: name: response namespace: https://apiv2.fleetmon.com x-extra-attributes: timestamp: type: date-time x-example-object: code: 429 description: Only 200 requests per 30 days are allowed for this endpoint. message: Too Many Requests status: error security: - apikey: [] - apikey_authorization_header: [] - apikey_header: [] summary: Delivers a list of call items tags: - Zone Call produces: - application/json schemes: - https securityDefinitions: apikey: description: Auth via API-Key Query-Parameter in: query name: apikey type: apiKey apikey_authorization_header: description: 'Auth via API-Key in ''Authorization'' header field in the form ''Authorization: Token ''' in: header name: Authorization type: apiKey apikey_header: description: Auth via API-Key in 'Api-Key' header field in: header name: Api-Key type: apiKey swagger: '2.0' tags: - description: Returns historical AIS position reports with fixed period and rate, by MMSI. name: Historical Track API x-codename: ais_position x-tag-group: Professional Analysis - description: Delivers AIS messages of type 5, 19 & 24 for a specified MMSI number. name: Historical AIS Static Messages x-codename: ais_static - description: 'Returns the high level summary of a route to port, only including distance, costs, and the count of edges from the routing graph. ' name: Distance To Port x-codename: distancetoport x-tag-group: Professional Planing - description: Tracking of current positions for a modifiable list of vessels. name: Fleet Tracker x-codename: fleet x-tag-group: Professional Monitoring - description: Delivers ETA & Destination Change for vessels. name: Vessel ETA & Destination Change Events x-codename: lng_vessel_events - description: Delivers information about the vessels current state and the next port it is heading for. name: Logistics x-codename: logistics_vessel x-tag-group: Professional Planing - description: Returns current info for lat/lon (and timestamp). name: Current x-codename: meteo_current - description: Returns wave info for lat/lon (and timestamp). name: Water x-codename: meteo_wave - description: Returns weather info for lat/lon (and timestamp). name: Weather x-codename: meteo_weather - description: Delivers your MyFleet or a single vessel of it. name: My Fleet Positions x-codename: myfleet x-tag-group: Basic Account - description: Delivers information about the next port, provided by the vessel itself via AIS destination. name: Next Port / ETA Calculation x-codename: next_port x-tag-group: Professional Planing - description: Delivers owner, manager, DWT, GT and a photo-URL for a vessel, if it's available. name: Non AIS Vessel Particulars x-codename: nonaisparticulars x-tag-group: Professional Monitoring - description: Lists vessels heading for a specific port, matched by AIS destination. name: Expected Port Arrivals x-codename: port_arrivals x-tag-group: Professional Planing - description: Lists vessels detected in port for the specified LOCODE. name: Vessels in Port x-codename: port_inport x-tag-group: Professional Monitoring - description: Delivers portcalls for a port. name: Port Calls per Port x-codename: portportcall x-tag-group: Professional Analysis - description: Allows lookup of ports by UN/LOCODE, name and/or country. name: Port Search x-codename: portsearch x-tag-group: Basic Account - description: delivers AIS informations for a predefined bounding box name: Regional AIS x-codename: regional_ais x-tag-group: Professional Monitoring - description: "This API deliver the enter and left event of the RoRo-Ferry-Terminal Rostock. It is no\ \ API key necessary. The look back is 48h.\r\nIt will be provides information about the Terminal Call\ \ itself, information's about the vessel in moment of arrival and depute as well as additional vessel\ \ information like length or call sigh." name: RoRo Ferry Terminal Demo x-codename: terminal_call_demo - description: Generate new Login Tokens with Token Keys name: Login Token x-codename: user_login_api x-tag-group: Login Token - description: Returns the identifying attributes of the provided vessel. name: Vessel Identity x-codename: vessel-identity x-tag-group: Professional Monitoring - description: Returns the latest received position. name: Vessel Positions Only x-codename: vessel-position-only x-tag-group: Professional Monitoring - description: Live Dynamic AIS data from requested vessel name: Vessel Dynamic AIS x-codename: vessel_dynamic_ais x-tag-group: Professional Monitoring - description: Delivers change events for vessels. name: Vessel Change Events x-codename: vessel_events x-tag-group: Professional Monitoring - description: Returns the actual route from last port to latest position. name: Vessel Route From Last Port x-codename: vessel_route_from_last_port x-tag-group: Professional Planing - description: Returns the route to the next port of a vessel (using ObjectID). name: Vessel Route To Next Port x-codename: vessel_route_to_next_port x-tag-group: Professional Planing - description: Delivers basic static data for a vessel. name: Basic Vessel Data x-codename: vesselbasic x-tag-group: Professional Monitoring - description: This API returns an estimated laytime for a vessel in all terminals of a port. name: Estimated Laytime - Specific Vessel x-codename: vessellaytime x-tag-group: Professional Planing - description: Delivers position and extended detailed information for a single vessel. name: Vessel Positions with Extended Vessel Data x-codename: vesselparticulars - description: Delivers the URL to the main photo for a vessel. Look-up can be done by Vessel ID or IMO-number. name: Vessel Photo x-codename: vesselphoto x-tag-group: Professional Monitoring - description: Delivers portcalls for a vessel. name: Port Calls per Vessel x-codename: vesselportcall x-tag-group: Professional Analysis - description: Vessels near requested position name: Vessels Near Position x-codename: vessels_near_position x-tag-group: Professional Monitoring - description: Vessels nearby requested vessel name: Vessels Nearby x-codename: vessels_nearby x-tag-group: Professional Monitoring - description: This endpoint provides schedules for vessels, e.g. container schedules. name: Vessel Schedule x-codename: vesselschedule x-tag-group: Professional Monitoring - description: Allows searching over the FleetMon vessel database by name, IMO-number, MMSI-number and/or callsign. name: Vessel Search x-codename: vesselsearch x-tag-group: Basic Account - description: Delivers ETA & distance estimations for a route with multiple ports specified by LOCODE. name: Voyage Planning x-codename: voyage_planning x-tag-group: Professional Planing - description: Delivers an overview of your geo-zones. name: Zone Information x-codename: zone - description: Zone Call API name: Zone Call x-codename: zone_call x-tagGroups: - name: My tags: - My API Keys - My Client - My User Notification Setting - My User Alert Addresses - Login Token - name: Vessels tags: - Vessel Search - Vessel Photo - Vessel Schedule - Next Port / ETA Calculation - Vessel History - Vessel Positions Only - Vessel Identity - Vessel Route To Next Port - Vessels Nearby - Vessels Near Position - Historical AIS Static Messages - Historical Track API - Vessel Positions with Extended Vessel Data - Port Calls per Vessel - Vessel Coarse Type - ETA Reports - Basic Vessel Data - Non AIS Vessel Particulars - Vessel Time to Port - Vessel Change Events - Voyage Planning - Vessel Dynamic AIS - name: Ports tags: - Expected Port Arrivals - Vessels in Port - Port Search - Port Calls per Port - name: Fleets tags: - Fleet Tracker - My Fleet Positions - Dry and Bulk Cargo Fleet - name: Logistics tags: - Logistics - RoRo Ferry Terminal Demo - Vessel ETA & Destination Change Events - Terminals - Estimated Laytime - Specific Vessel - name: Zone tags: - Regional AIS - Zone Call - Zone Information - User Zones - name: Routing tags: - Route To Port - Distance To Port - Vessel Route To Next Port - Vessel Route From Last Port - name: Weather & Water tags: - Weather - Water - Current