{"source":"ais","operation":"get_vessel_position","description":"Get one vessel's latest position with a human-readable location\n(\"3.2 km NW of Kristiansund\"), speed, course and navigational status.","parameters":[{"name":"vessel","schema":{"description":"Vessel name, call sign, IMO number or MMSI.","type":"string"},"required":true,"default":null,"description":"Vessel name (e.g. \"KV Svalbard\"), 9-digit MMSI, or 7-digit IMO number."},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100)."},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page."}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_vessel_position?vessel={vessel}&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"name":{"type":"boolean"},"mmsi":{"type":["integer","null"]},"type":{"anyOf":[{"type":"null"},{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"string"}]},"lat":{"type":["number","null"]},"lon":{"type":["number","null"]},"location":{"type":"boolean"},"speed_kn":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"course":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"heading":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"anyOf":[{"type":"null"},{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}]}]},"nav_status":{"anyOf":[{"type":"null"},{"type":"string"}]},"destination":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"eta":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"null"},{"type":"string"}]},"draught_m":{"anyOf":[{"type":"number"},{"type":"null"}]},"position_time":{"type":["string","null"],"format":"date-time"},"position_age_min":{"anyOf":[{"type":"null"},{"type":"number"}]}},"additionalProperties":false},"response_schema_status":{"status":"incomplete","codegen_safe":false,"description":"Not suitable for typed model generation: the container shape and field names are useful, but unresolved values accept any JSON value."},"entity_projection":{"status":"projected","entity_types":["vessel"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"}},"required":["self","api_index"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_vessel_position/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/ais/get_vessel_position","source":"https://allemannsdata.com/wiki/api/v1/kilder/ais"},"output_fields":["name","mmsi","type","lat","lon","location","speed_kn","course","heading","nav_status","destination","eta","draught_m","position_time","position_age_min"],"output_fields_truncated":false,"canonical_field_aliases":{"name":["name","heading"],"identifier":["mmsi"],"latitude":["lat"],"longitude":["lon"]}}