BLbluestaq
AirOperations

GET /udl/navigationalobstruction/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/navigationalobstruction/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.

cycleDatestring date

(One or more of fields 'cycleDate, obstacleId' are required.) Start date of this obstruction data set's currency, in ISO 8601 date-only format. (YYYY-MM-DD)

obstacleIdstring

(One or more of fields 'cycleDate, obstacleId' are required.) The ID of this obstacle.

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.

cycleDatestring date required

Start date of this obstruction data set's currency, in ISO 8601 date-only format.

obstacleTypestring required

Type of obstacle (e.g. P for point, V for vector, L for line).

obstacleIdstring required

The ID of this obstacle.

externalIdstring

Optional obstacle ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

origIdstring

The original ID for this obstacle.

countryCodestring

The DoD Standard Country Code designator for the country issuing the diplomatic clearance. This field will be set to "OTHR" if the source value does not match a UDL Country code value (ISO-3166-ALPHA-2).

provinceCodestring

The Federal Information Processing Standards (FIPS) state/province numeric code of this obstacle's location.

pointLatnumber double

WGS-84 latitude of this point obstacle, in degrees. -90 to 90 degrees (negative values south of equator).

pointLonnumber double

WGS-84 longitude of this point obstacle, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

lineNELonnumber double

WGS-84 longitude of the northeastern point of the line, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

lineNELatnumber double

WGS-84 latitude of the northeastern point of the line, in degrees. -90 to 90 degrees (negative values south of equator).

lineSWLonnumber double

WGS-84 longitude of the southwestern point of the line, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

lineSWLatnumber double

WGS-84 latitude of the southwestern point of the line, in degrees. -90 to 90 degrees (negative values south of equator).

segStartPointinteger

ID of the starting point of a line segment.

segEndPointinteger

ID of the end point of a line segment.

segNuminteger

Identifies the sequence number of a line segment.

faccstring

FACC (Feature and Attribute Coding Catalog) is a five-character code for encoding real-world entities and objects. The first letter of the code is an alphabetic value from "A" to "Z" which will map to a feature category. The second character will map to a subcategory. Characters three to five are numeric and range from 000 to 999. This value will provide a unit feature type identification within the categories.

featureCodestring

Identifying code for the type of this point obstacle.

featureTypestring

Identifying code for the type of this point obstacle.

featureNamestring

Type name of point obstacle.

featureDescriptionstring

Description of this obstacle, corresponding to the FACC (Feature and Attribute Coding Catalog) value.

wacstring

The World Aeronautical Chart (WAC) identifier for the area in which this obstacle is located.

wacINNRstring

This obstacle's World Area Code installation number (WAC-INNR).

multObsstring

Indicates if the feature has multiple obstructions (e.g. S = Single, M = Multiple, U = Undetermined).

numObsinteger

Indicates the number of obstructions associated with a feature.

horizDatumCodestring

Code representing the mathematical model of Earth used to calculate coordinates for this obstacle (e.g. WGS-84, U for undetermined, etc.). US Forces use the World Geodetic System 1984 (WGS-84), but also use maps by allied countries with local datums.

heightAGLnumber double

The height Above Ground Level (AGL) of the point obstacle in feet.

heightAGLAccnumber double

The accuracy of the height Above Ground Level (AGL) value for this point obstacle, in feet.

heightMSLnumber double

The height Above Mean Sea Level (AMSL) of the point obstacle in feet.

heightMSLAccnumber double

The accuracy of the height Above Mean Sea Level (AMSL) value for this point obstacle in feet.

elevationnumber double

The elevation at the point obstacle's location in feet.

elevationAccnumber double

The difference between the assigned elevation of this point and its true elevation, in feet.

horizAccnumber double

The difference between the recorded horizontal coordinates of this point obstacle and its true position, in feet.

qualitystring

When horizontal and/or vertical accuracy requirements cannot be met because of inadequate source material, this code indicates the quality of the data.

lightingCodestring

Code specifying if this obstacle is lit (e.g. Y = Yes, N = No, U = Unknown).

surfaceMatCodestring

The surface material composition code of this point obstacle.

directivityCodeinteger

The side or sides of this obstruction feature which produces the greatest reflectivity potential.

validationCodeinteger

Method used to confirm the existence of this obstacle.

transactionCodestring

The transaction type/code for this obstacle (e.g. "D", "N", "R", "S", "V", "X").

processCodestring

Code denoting the action, review, or process that updated this obstacle.

actDelCodestring

Indicates if this obstacle record is Active (A) or Deleted (D).

producerstring

Name of the agency that produced this obstruction data set.

derivingOrgstring

The organization that entered obstacle data other than the producer.

deletingOrgstring

The organization that deleted this obstacle record.

sourceDatestring date

Source date of this obstacle data, in ISO 8601 date-only format (ex. YYYY-MM-DD).

revDatestring date

Date this obstacle data was revised, in ISO 8601 date-only format (ex. YYYY-MM-DD).

initRecordDatestring date

Date this obstacle was initially added to the data set, in ISO 8601 date-only format (ex. YYYY-MM-DD).

keysstring[]

This field provides an array of keys that can be added to any obstruction feature to provide information that is not already supported. The entries in this array must correspond to the position index in the values array. This array must be the same length as values.

valuesstring[]

This field provides an array of values that can be added to any obstruction feature to provide information that is not already supported. The entries in this array must correspond to the position index in the keys array. This array must be the same length as keys.

obstacleRemarksstring

Remarks regarding this obstacle.

nextCycleDatestring date

The date after which this obstruction data set’s currency is stale and should be refreshed, in ISO 8601 date-only format (e.g. YYYY-MM-DD).

baselineCutoffDatestring date

Earliest record date possible in this obstruction data set (not the earliest data item), in ISO 8601 date-only format (e.g. YYYY-MM-DD). If null, this data set is assumed to be a full data pull of holdings until the cutoffDate. If this field is populated, this data set only contains updates since the last baseline data set.

cutoffDatestring date

Latest record date possible in this obstruction data set (not the most recent data item), in ISO 8601 date-only format (e.g. YYYY-MM-DD).

airacCycleinteger

The Aeronautical Information Regulation and Control (AIRAC) cycle of this obstruction data set. The format is YYNN where YY is the last two digits of the year and NN is the cycle number.

baseAiracCycleinteger

The baseline Aeronautical Information Regulation and Control (AIRAC) cycle for change sets only. The format is YYNN where YY is the last two digits of the year and NN is the cycle number.

ownerCountryCodestring

The DoD Standard Country Code designator for the country or political entity that owns the data set associated with this obstruction. This field will be set to "OTHR" if the source value does not match a UDL Country code value (ISO-3166-ALPHA-2).

boundNELonnumber double

WGS-84 longitude of the northeastern boundary for obstructions contained in this data set, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

boundNELatnumber double

WGS-84 latitude of the northeastern boundary for obstructions contained in this data set, in degrees. -90 to 90 degrees (negative values south of equator).

boundSWLonnumber double

WGS-84 longitude of the southwestern boundary for obstructions contained in this data set, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

boundSWLatnumber double

WGS-84 latitude of the southwestern boundary for obstructions contained in this data set, in degrees. -90 to 90 degrees (negative values south of equator).

minHeightAGLnumber double

The minimum height Above Ground Level (AGL) of the shortest obstruction contained in this data set, in feet.

numPointsinteger

The number of point features associated with this obstruction data set.

numLinesinteger

The number of line features associated with this obstruction data set.

dataSetRemarksstring

Remarks concerning this obstruction's data set.

pointsFilenamestring

The name of the point file associated with this obstruction data set.

linesFilenamestring

The name of the line file associated with this obstruction data set.

vectorsFilenamestring

The name of the vector file associated with this obstruction data set.

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.

updatedAtstring date-time

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

updatedBystring

Application user who updated 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 response

[
  {
    "id": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "cycleDate": "2024-06-13",
    "obstacleType": "V",
    "obstacleId": "359655",
    "externalId": "OU812",
    "origId": "L0000002289",
    "countryCode": "US",
    "provinceCode": "23",
    "pointLat": 46.757211,
    "pointLon": -67.759494,
    "lineNELon": -122.197891,
    "lineNELat": 49.000584,
    "lineSWLon": -122.722946,
    "lineSWLat": 48.507027,
    "segStartPoint": 359655,
    "segEndPoint": 359655,
    "segNum": 1,
    "facc": "AT040",
    "featureCode": "540",
    "featureType": "540",
    "featureName": "PYLON",
    "featureDescription": "Powerline Pylon, General",
    "wac": "262",
    "wacINNR": "0409-00039",
    "multObs": "S",
    "numObs": 1,
    "horizDatumCode": "WGS-84",
    "heightAGL": 314.1,
    "heightAGLAcc": 30.1,
    "heightMSL": 1154.1,
    "heightMSLAcc": 34.1,
    "elevation": 840.1,
    "elevationAcc": 17.1,
    "horizAcc": 8.1,
    "quality": "0",
    "lightingCode": "U",
    "surfaceMatCode": "U",
    "directivityCode": 2,
    "validationCode": 3,
    "transactionCode": "V",
    "processCode": "OT",
    "actDelCode": "A",
    "producer": "ACME",
    "derivingOrg": "ACME",
    "deletingOrg": "ACME",
    "sourceDate": "2016-04-01",
    "revDate": "2020-02-26",
    "initRecordDate": "1991-03-28",
    "keys": [
      "key1",
      "key2"
    ],
    "values": [
      "value1",
      "value2"
    ],
    "obstacleRemarks": "Obstacle remarks",
    "nextCycleDate": "2024-07-11",
    "baselineCutoffDate": "2024-04-23",
    "cutoffDate": "2024-05-21",
    "airacCycle": 2406,
    "baseAiracCycle": 2405,
    "ownerCountryCode": "US",
    "boundNELon": 99.1,
    "boundNELat": 29.1,
    "boundSWLon": -144.1,
    "boundSWLat": -44.1,
    "minHeightAGL": 20.1,
    "numPoints": 21830590,
    "numLines": 45993,
    "dataSetRemarks": "Data set remarks",
    "pointsFilename": "points.txt",
    "linesFilename": "lines.txt",
    "vectorsFilename": "vectors.txt",
    "createdAt": "2022-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

  • 45631f9bb3f0Revision changes
    • warning

      removed the optional property / from the response with the status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.