Aircraft

GET /udl/aircraft

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

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

Query parameters

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.

idEntitystring

ID of the parent entity for this aircraft.

aircraftMDSstring required

The aircraft Model Design Series (MDS) designation (e.g. E-2C HAWKEYE, F-15 EAGLE, KC-130 HERCULES, etc.) of this aircraft. Intended as, but not constrained to, MIL-STD-6016 environment dependent specific type designations.

tailNumberstring

The tail number of this aircraft.

serialNumberstring

Full serial number of the aircraft.

ownerstring

The wing or unit that owns the aircraft.

commandstring

The Air Force major command (MAJCOM) overseeing the aircraft.

categorystring

The category of aircraft (e.g. M = Military, C = Commercial).

dtdstring

Military data network data transfer device ID for this aircraft.

cruiseSpeednumber double

The cruise speed of the aircraft, in kilometers/hour.

maxSpeednumber double

The maximum air speed of the aircraft, in kilometers/hour.

minReqRunwayMinteger

The minimum length of runway required to land this aircraft, in meters. Note: The corresponding equivalent field is not converted by the UDL and may or may not be supplied by the provider. The provider/consumer is responsible for all unit conversions.

minReqRunwayFtinteger

The minimum length of runway required to land this aircraft, in feet. Note: The corresponding equivalent field is not converted by the UDL and may or may not be supplied by the provider. The provider/consumer is responsible for all unit conversions.

nominalTATimeinteger

The nominal turnaround time for this aircraft, in minutes.

notesstring

Optional notes/comments for this aircraft.

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.

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.

sourcestring required

Source of the data.

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": "0167f577-e06c-358e-85aa-0a07a730bdd0",
    "classificationMarking": "U",
    "idEntity": "0167f577-e06c-358e-85aa-0a07a730bdd0",
    "aircraftMDS": "E-2C HAWKEYE",
    "tailNumber": "N702JG",
    "serialNumber": "7007187",
    "owner": "437AW",
    "command": "HQACC",
    "category": "M",
    "dtd": "005",
    "cruiseSpeed": 915,
    "maxSpeed": 2655.1,
    "minReqRunwayM": 1000,
    "minReqRunwayFt": 3000,
    "nominalTATime": 500,
    "notes": "Notes for this aircraft",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

    • info

      api operation id findAll_5 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.