BLbluestaq
AIS

GET /udl/ais/tuple

Changed on

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/ais/tuple
  • Auth
    none declared

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

tsstring date-time required

The timestamp that the vessel position was recorded, in ISO 8601 UTC format. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

idTrackstring

Unique identifier of the Track.

idVesselstring

Unique identifier of the vessel.

mmsiinteger

The Maritime Mobile Service Identity of the vessel. MMSI is a nine-digit number that identifies the transmitter station of the vessel.

imoninteger

The International Maritime Organization Number of the vessel. IMON is a seven-digit number that uniquely identifies the vessel.

tsstring date-time required

The timestamp that the vessel position was recorded, in ISO 8601 UTC format.

shipNamestring

The name of the vessel. Vessel names that exceed the AIS 20 character are shortened (not truncated) to 15 character-spaces, followed by an underscore and the last 4 characters-spaces of the vessel full name.

shipTypestring

The reported ship type (e.g. Passenger, Tanker, Cargo, Other, etc.). See the engagedIn and specialCraft entries for additional information on certain types of vessels.

engagedInstring

The activity that the vessel is engaged in. This entry applies only when the shipType = Other.

specialCraftstring

The type of special craft designation of the vessel. This entry applies only when the shipType = Special Craft.

cargoTypestring

The reported cargo type. Intended as, but not constrained to, the USCG NAVCEN AIS cargo definitions. Users should refer to USCG Navigation Center documentation for specific definitions associated with ship and cargo types. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov.

callSignstring

A uniquely designated identifier for the vessel's transmitter station.

vesselFlagstring

The flag of the subject vessel according to AIS transmission.

latnumber double

WGS-84 latitude of the vessel position, in degrees. -90 to 90 degrees (negative values south of equator).

lonnumber double

WGS-84 longitude of the vessel position, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

posHiAccuracyboolean

Flag indicating high reported position accuracy (less than or equal to 10 meters). A value of 0/false indicates low accuracy (greater than 10 meters).

posHiLatencyboolean

Flag indicating high reported position latency (greater than 5 seconds). A value of 0/false indicates low latency (less than 5 seconds).

speednumber double

The speed-over-ground reported by the vessel, in kilometers/hour.

trueHeadingnumber double

The true heading reported by the vessel, in degrees.

coursenumber double

The course-over-ground reported by the vessel, in degrees.

rateOfTurnnumber double

The Rate-of-Turn for the vessel, in degrees/minute. Positive value indicates that the vessel is turning right.

specialManeuverboolean

Flag indicating that the vessel is engaged in a special maneuver (e.g. Waterway Navigation).

navStatusstring

The AIS Navigational Status of the vessel (e.g. Underway Using Engine, Moored, Aground, etc.). Intended as, but not constrained to, the USCG NAVCEN navigation status definitions. Users should refer to USCG Navigation Center documentation for specific definitions associated with navigation status. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov.

posDeviceTypestring

The type of electronic position fixing device (e.g. GPS, GLONASS, etc.). Intended as, but not constrained to, the USCG NAVCEN electronic position fixing device definitions. Users should refer to USCG Navigation Center documentation for specific device type information. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov.

antennaRefDimensionsnumber[]

The reference dimensions of the vessel, reported as [A, B, C, D], in meters. Where the array values represent the distance fore (A), aft (B), to port (C), and to starboard (D) of the navigation antenna. Array with values A = C = 0 and B, D > 0 indicate the length (B) and width (D) of the vessel without antenna position reference.

lengthnumber double

The overall length of the vessel, in meters. A value of 511 indicates a vessel length of 511 meters or greater.

widthnumber double

The breadth of the vessel, in meters. A value of 63 indicates a vessel breadth of 63 meters or greater.

draughtnumber double

The maximum static draught, in meters, of the vessel according to the AIS transmission.

shipDescriptionstring

Further description or explanation of the vessel or type.

destinationstring

The destination of the vessel according to the AIS transmission.

destinationETAstring date-time

The Estimated Time of Arrival of the vessel at the destination, in ISO 8601 UTC format.

currentPortGUIDstring

The US Geographic Unique Identifier of the current port hosting the vessel.

currentPortLOCODEstring

The UN Location Code of the current port hosting the vessel.

lastPortGUIDstring

The US Geographic Unique Identifier of the last port visited by the vessel.

lastPortLOCODEstring

The UN Location Code of the last port visited by the vessel.

nextPortGUIDstring

The US Geographic Unique Identifier of the next destination port of the vessel.

nextPortLOCODEstring

The UN Location Code of the next destination port of the vessel.

etaCalculatedstring date-time

The Estimated Time of Arrival of the vessel at the destination port, according to MarineTraffic calculations, in ISO 8601 UTC format.

etaUpdatedstring date-time

The date and time that the ETA was calculated by MarineTraffic, in ISO 8601 UTC format.

distanceToGonumber double

The remaining distance, in kilometers, for the vessel to reach the reported destination.

distanceTravellednumber double

The distance, in kilometers, that the vessel has travelled since departing the last port.

avgSpeednumber double

The average speed, in kilometers/hour, calculated for the subject vessel during the latest voyage (port to port).

maxSpeednumber double

The maximum speed, in kilometers/hour, reported by the subject vessel during the latest voyage (port to port).

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "id": "AIS-ID",
    "classificationMarking": "U",
    "idTrack": "TRACK-ID",
    "idVessel": "VESSEL-ID",
    "mmsi": 304010417,
    "imon": 9015462,
    "ts": "2021-02-25T12:00:00.123456Z",
    "shipName": "DORNUM",
    "shipType": "Passenger",
    "engagedIn": "Cargo",
    "specialCraft": "Tug",
    "cargoType": "Freight",
    "callSign": "V2OZ",
    "vesselFlag": "United States",
    "lat": 47.758499,
    "lon": -5.154223,
    "posHiAccuracy": true,
    "posHiLatency": true,
    "speed": 10.5,
    "trueHeading": 329.1,
    "course": 157.1,
    "rateOfTurn": 22.1,
    "navStatus": "Underway Using Engine",
    "posDeviceType": "GPS",
    "antennaRefDimensions": [
      50.1,
      50.1,
      20.1,
      20.1
    ],
    "length": 511.1,
    "width": 24.1,
    "draught": 21.1,
    "shipDescription": "Search and rescue vessels",
    "destination": "USCLE",
    "destinationETA": "2021-02-25T12:00:00.123456Z",
    "currentPortGUID": "0ABC",
    "currentPortLOCODE": "XF013",
    "lastPortGUID": "0VAX",
    "lastPortLOCODE": "USSKY",
    "nextPortGUID": "0Z8Q",
    "nextPortLOCODE": "USCLE",
    "etaCalculated": "2021-02-25T12:00:00.123456Z",
    "etaUpdated": "2021-02-25T12:00:00.123456Z",
    "distanceToGo": 150.5,
    "distanceTravelled": 200.3,
    "avgSpeed": 12.1,
    "maxSpeed": 13.3,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "sourceDL": "AXE",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAllTuples removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.