BLbluestaq
Site

POST /udl/airfield

Changed on

Service operation to take a single Airfield as a POST body and ingest into the database. This operation is not intended to be used for automated feeds into UDL. Data providers should contact the UDL team for specific role assignments and for instructions on setting up a permanent feed through an alternate mechanism.

Request

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

Request body

idstring

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

classificationMarkingstring required

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

idSitestring

The ID of the parent site.

altAirfieldIdstring

Alternate Airfield identifier provided by source.

wacINNRstring

The airfield's World Area Code installation number (WAC-INNR).

zarIdstring

Air Mobility Command (AMC) Zone availability Report identifier.

icaostring

The International Civil Aviation Organization (ICAO) code of the airfield.

iatastring

The International Aviation Transport Association (IATA) code of the airfield.

faastring

The Federal Aviation Administration (FAA) location identifier of this airfield.

hostNatCodestring

The host nation code of this airfield, used for non-DoD/FAA locations.

namestring required

The name of the airfield.

typestring required

The airfield activity use type (e.g. Commercial, Airport, Heliport, Gliderport, etc.).

secondaryICAOstring

The secondary ICAO code for this airfield. Some airfields have two associated ICAO codes, this can occur in cases when a single airfield supports both military and civilian operations.

alternativeNamesstring[]

Alternative names for this airfield.

latnumber double

WGS84 latitude of the location, in degrees. -90 to 90 degrees (negative values south of equator).

lonnumber double

WGS84 longitude of the location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

elevFtnumber double

Elevation of the airfield above mean sea level, 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.

elevMnumber double

Elevation of the airfield above mean sea level, 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.

magDecnumber double

The magnetic declination/variation of the airfield's location from true north, in degrees. Positive values east of true north and negative values west of true north.

regionalAuthoritystring

The regional authority of the airfield.

regionNamestring

Region where the airfield resides.

countryCodestring

The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

countryNamestring

The country name where this airfield is located.

citystring

The closest city to the location of this airfield.

stateProvinceCodestring

The code for the state or province in which this airfield is located. Intended as, but not constrained to, FIPS 10-4 region code designations.

statestring

State or province of the airfield's location.

geolocstring

Air Force geographic location code of the airfield.

gmtOffsetstring

Time difference between the location of the airfield and the Greenwich Mean Time (GMT), expressed as +/-HH:MM. Time zones east of Greenwich have positive offsets and time zones west of Greenwich are negative.

dstInfostring

Information regarding daylight saving time as is relevant to the location and operation of this airfield.

suitabilityCodesstring

Associated suitability codes according to the Airfield Suitability and Restrictions Report (ASRR) for this airfield.

suitabilityCodeDescsstring[]

Array of descriptions for given suitability codes. The index of the description corresponds to the position of the letter code in the string provided in the suitabilityCodes field.

miscCodesstring

Applicable miscellaneous codes according to the Airfield Suitability and Restrictions Report (ASRR) for this airfield.

runwaysinteger

The number of runways at the site.

maxRunwayLengthinteger

The length of the longest runway at this airfield in feet.

infoURLstring

The URL link to information about airfield.

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.

origNetworkstring

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

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.

Example request

{
  "id": "3f28f60b-3a50-2aef-ac88-8e9d0e39912b",
  "classificationMarking": "U",
  "idSite": "a150b3ee-884b-b9ac-60a0-6408b4b16088",
  "altAirfieldId": "45301",
  "wacINNR": "0409-00039",
  "zarId": "231",
  "icao": "KCOS",
  "iata": "AAA",
  "faa": "FAA1",
  "hostNatCode": "ZPU",
  "name": "Hickam Air Force Base",
  "type": "Commercial",
  "secondaryICAO": "PHNL",
  "alternativeNames": [
    "BELLEVILLE",
    "JONESTOWN"
  ],
  "lat": 45.23,
  "lon": 179.1,
  "elevFt": 33.562,
  "elevM": 10.29,
  "magDec": 7.35,
  "regionalAuthority": "18TH AF",
  "regionName": "Hawaii",
  "countryCode": "US",
  "countryName": "United States",
  "city": "Honolulu",
  "stateProvinceCode": "US15",
  "state": "Hawaii",
  "geoloc": "XLSX",
  "gmtOffset": "-4:30",
  "dstInfo": "SEE THE ENROUTE SUPP FOR INFORMATION",
  "suitabilityCodes": "ABC",
  "suitabilityCodeDescs": [
    "Suitable C-32",
    "Suitable C-5",
    "Suitable C-130"
  ],
  "miscCodes": "AMZ",
  "runways": 5,
  "maxRunwayLength": 1000,
  "infoURL": "URL Link to the Airfield",
  "createdAt": "2022-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

  • 75f764c843a9Revision changes
    • breaking

      request body became required

    • info

      api operation id create_8 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

Some revisions have not been checked yet.