Site

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

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.

namestring required

The surface name or identifier.

typestring required

The surface type of this record (e.g. RUNWAY, TAXIWAY, PARKING).

idSitestring

The unique identifier of the Site record that contains location information about this surface.

altSiteIdstring

Alternate site identifier provided by the source.

primaryboolean

Flag indicating this is the primary runway. Applicable for runway surface types only.

lengthFtnumber double

The length of the surface type, in feet. Applicable for runway and parking surface types.

ldaFtnumber double

The landing distance available for the runway, in feet. Applicable for runway surface types only.

widthFtnumber double

The width of the surface type, in feet.

lengthMnumber double

The length of the surface type, in meters. Applicable for runway and parking surface types.

ldaMnumber double

The landing distance available for the runway, in meters. Applicable for runway surface types only.

widthMnumber double

The width of the surface type, in meters.

startLatnumber double

WGS-84 latitude of the coordinate representing the start-point of a surface, in degrees. -90 to 90 degrees (negative values south of equator).

startLonnumber double

WGS-84 longitude of the coordinate representing the start-point of a surface, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

endLatnumber double

WGS-84 latitude of the coordinate representing the end-point of a surface, in degrees. -90 to 90 degrees (negative values south of equator).

endLonnumber double

WGS-84 longitude of the coordinate representing the end-point of a surface, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

pointReferencestring

Description of the surface and its dimensions or how it is measured or oriented.

materialstring

The surface material (e.g. Asphalt, Concrete, Dirt).

conditionstring

The surface condition (e.g. GOOD, FAIR, POOR, SERIOUS, FAILED, CLOSED, UNKNOWN).

rawWBCstring

Raw weight bearing capacity value or pavement strength.

pcnstring

Pavement classification number (PCN) and tire pressure code.

lcninteger

Load classification number or pavement rating which ranks aircraft on a scale of 1 to 120.

sWtKipnumber double

The max weight allowable on this surface type for an S-type (single) landing gear configuration, in kilopounds (kip). 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.

sWtKipModnumber double

The modified max weight allowable on this surface type for an S-type (single) landing gear configuration, in kilopounds (kip).

sWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for an S-type (single) landing gear configuration. For more information, contact the provider source.

tWtKipnumber double

The max weight allowable on this surface type for a T-type (twin (dual)) landing gear configuration, in kilopounds (kip).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.

tWtKipModnumber double

The modified max weight allowable on this surface type for a T-type (twin (dual)) landing gear configuration, in kilopounds (kip).

tWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for a T-type (twin(dual)) landing gear configuration. For more information, contact the provider source.

stWtKipnumber double

The max weight allowable on this surface type for an ST-type (single tandem) landing gear configuration, in kilopounds (kip).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.

stWtKipModnumber double

The modified max weight allowable on this surface type for an ST-type (single tandem) landing gear configuration, in kilopounds (kip).

stWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for an ST-type (single tandem) landing gear configuration. For more information, contact the provider source.

ttWtKipnumber double

The max weight allowable on this surface type for a GDSS TT-type (twin tandem) landing gear configuration, in kilopounds (kip).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.

ttWtKipModnumber double

The modified max weight allowable on this surface type for a GDSS TT-type (twin tandem) landing gear configuration, in kilopounds (kip).

ttWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for a GDSS TT-type (twin tandem) landing gear configuration. For more information, contact the provider source.

ddWtKipnumber double

The max weight allowable on this surface type for an FAA 2D-type (twin tandem) landing gear configuration, in kilopounds (kip).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.

ddWtKipModnumber double

The modified max weight allowable on this surface type for an FAA 2D-type (twin tandem) landing gear configuration, in kilopounds (kip).

ddWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for an FAA 2D-type (twin tandem) landing gear configuration. For more information, contact the provider source.

sbttWtKipnumber double

The max weight allowable on this surface type for an SBTT-type (single belly twin tandem) landing gear configuration, in kilopounds (kip).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.

sbttWtKipModnumber double

The modified max weight allowable on this surface type for an SBTT-type (single belly twin tandem) landing gear configuration, in kilopounds (kip).

sbttWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for an SBTT-type (single belly twin tandem) landing gear configuration. For more information, contact the provider source.

tdtWtkipnumber double

The max weight allowable on this surface type for a TDT-type (twin delta tandem) landing gear configuration, in kilopounds (kip).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.

tdtWtKipModnumber double

The modified max weight allowable on this surface type for a TDT-type (twin delta tandem) landing gear configuration, in kilopounds (kip).

tdtWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for a TDT-type (twin delta tandem) landing gear configuration. For more information, contact the provider source.

trtWtKipnumber double

The max weight allowable on this surface type for a TRT-type (triple tandem) landing gear configuration, in kilopounds (kip).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.

trtWtKipModnumber double

The modified max weight allowable on this surface type for a TRT-type (triple tandem) landing gear configuration, in kilopounds (kip).

trtWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for a TRT-type (triple tandem) landing gear configuration. For more information, contact the provider source.

ddtWtKipnumber double

The max weight allowable on this surface type for a DDT-type (double dual tandem) landing gear configuration, in kilopounds (kip).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.

ddtWtKipModnumber double

The modified max weight allowable on this surface type for a DDT-type (double dual tandem) landing gear configuration, in kilopounds (kip).

ddtWtKipModNotestring

User input rationale for the manual modification of the prescribed value indicating the max weight allowable on this surface for a DDT-type (double dual tandem) landing gear configuration. For more information, contact the provider source.

sWtKNnumber double

The max weight allowable on this surface type for an S-type (single) landing gear configuration, in kilonewtons (kN).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.

tWtKNnumber double

The max weight allowable on this surface type for a T-type (twin (dual)) landing gear configuration, in kilonewtons (kN).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.

stWtKNnumber double

The max weight allowable on this surface type for an ST-type (single tandem) landing gear configuration, in kilonewtons (kN).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.

ttWtKNnumber double

The max weight allowable on this surface type for a GDSS TT-type (twin tandem) landing gear configuration, in kilonewtons (kN).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.

ddWtKNnumber double

The max weight allowable on this surface type for an FAA 2D-type (twin tandem) landing gear configuration, in kilonewtons (kN).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.

sbttWtKNnumber double

The max weight allowable on this surface type for an SBTT-type (single belly twin tandem) landing gear configuration, in kilonewtons (kN).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.

tdtWtKNnumber double

The max weight allowable on this surface type for a TDT-type (twin delta tandem) landing gear configuration, in kilonewtons (kN).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.

trtWtKNnumber double

The max weight allowable on this surface type for a TRT-type (triple tandem) landing gear configuration, in kilonewtons (kN).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.

ddtWtKNnumber double

The max weight allowable on this surface type for a DDT-type (double dual tandem) landing gear configuration, in kilonewtons (kN).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.

lightingboolean

Flag indicating the surface has lighting.

lightsUNKNboolean

Flag indicating the runway lighting is unknown. Applicable for runway surface types only.

lightsAPRCHboolean

Flag indicating the runway has approach lights. Applicable for runway surface types only.

lightsRWYboolean

Flag indicating the runway has edge lighting. Applicable for runway surface types only.

lightsSEQFLboolean

Flag indicating the runway has Sequential Flashing (SEQFL) lights. Applicable for runway surface types only.

lightsVASIboolean

Flag indicating the runway has Visual Approach Slope Indicator (VASI) lights. Applicable for runway surface types only.

lightsPAPIboolean

Flag indicating the runway has Precision Approach Path Indicator (PAPI) lights. Applicable for runway surface types only.

lightsOLSboolean

Flag indicating the runway has Optical Landing System (OLS) lights. Applicable for runway surface types only.

lightsREILboolean

Flag indicating the runway has Runway End Identifier Lights (REIL). Applicable for runway surface types only.

lightsTDZLboolean

Flag indicating the runway has Touchdown Zone lights. Applicable for runway surface types only.

lightsCLboolean

Flag indicating the runway has centerline lights. Applicable for runway surface types only.

obstacleboolean

Flag indicating that one or more obstacles or obstructions exist in the proximity of this surface.

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.

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' | 'EXERCISE' | 'SIMULATED' 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": "be831d39-1822-da9f-7ace-6cc5643397dc",
    "classificationMarking": "U",
    "name": "West lot",
    "type": "PARKING",
    "idSite": "SITE-ID",
    "altSiteId": "ORIG-SITE-ID",
    "primary": true,
    "lengthFt": 1500.75,
    "ldaFt": 475.2,
    "widthFt": 220.3,
    "lengthM": 457.5,
    "ldaM": 145.75,
    "widthM": 67.25,
    "startLat": 46.757211,
    "startLon": -67.759494,
    "endLat": 45.844,
    "endLon": -67.0094,
    "pointReference": "Reference Point Example",
    "material": "Concrete",
    "condition": "GOOD",
    "rawWBC": "LCN 42",
    "pcn": "73RBWT",
    "lcn": 50,
    "sWtKip": 143.5,
    "sWtKipMod": 107.625,
    "sWtKipModNote": "Observed 25% reduction in surface integrity.",
    "tWtKip": 188.2,
    "tWtKipMod": 141.15,
    "tWtKipModNote": "Observed 25% reduction in surface integrity.",
    "stWtKip": 195.75,
    "stWtKipMod": 146.8125,
    "stWtKipModNote": "Observed 25% reduction in surface integrity.",
    "ttWtKip": 414.9,
    "ttWtKipMod": 311.175,
    "ttWtKipModNote": "Observed 25% reduction in surface integrity.",
    "ddWtKip": 416.25,
    "ddWtKipMod": 312.1875,
    "ddWtKipModNote": "Observed 25% reduction in surface integrity.",
    "sbttWtKip": 603.025,
    "sbttWtKipMod": 452.269,
    "sbttWtKipModNote": "Observed 25% reduction in surface integrity.",
    "tdtWtkip": 870.2,
    "tdtWtKipMod": 652.65,
    "tdtWtKipModNote": "Serious 25 percent reduction.",
    "trtWtKip": 622.85,
    "trtWtKipMod": 467.1375,
    "trtWtKipModNote": "Observed 25% reduction in surface integrity.",
    "ddtWtKip": 833.5,
    "ddtWtKipMod": 625.125,
    "ddtWtKipModNote": "Observed 25% reduction in surface integrity.",
    "sWtKN": 636.4,
    "tWtKN": 836.45,
    "stWtKN": 867.6,
    "ttWtKN": 1842.55,
    "ddWtKN": 1850.1,
    "sbttWtKN": 2682.05,
    "tdtWtKN": 3870.05,
    "trtWtKN": 2767.15,
    "ddtWtKN": 3705.44,
    "lighting": true,
    "lightsAPRCH": true,
    "lightsRWY": true,
    "lightsSEQFL": true,
    "lightsVASI": true,
    "lightsPAPI": true,
    "lightsOLS": true,
    "lightsREIL": true,
    "lightsTDZL": true,
    "lightsCL": true,
    "obstacle": true,
    "surfaceObstructions": [
      {
        "id": "be831d39-1822-da9f-7ace-6cc5643397dc",
        "classificationMarking": "U",
        "idSurface": "be831d39-1822-da9f-7ace-6cc5643397dc",
        "idNavigationalObstruction": "a2831d39-1822-da9f-7ace-6cc5643397da",
        "obstructionSideCode": "F",
        "obstructionDesc": "PYLON",
        "obstructionHeight": 35.25,
        "distanceFromEdge": 15.8,
        "distanceFromCenterLine": 17.8,
        "distanceFromThreshold": 19.5,
        "advisoryRequired": [
          "C20",
          "C17"
        ],
        "approvalRequired": [
          "C20",
          "C17"
        ],
        "createdAt": "2022-01-01T16:00:00.123Z",
        "createdBy": "some.user",
        "updatedAt": "2022-01-01T16:00:00.123Z",
        "updatedBy": "some.user",
        "source": "Bluestaq",
        "sourceDL": "AXE",
        "origin": "THIRD_PARTY_DATASOURCE",
        "origNetwork": "OPS1",
        "dataMode": "TEST"
      }
    ],
    "createdAt": "2022-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2022-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

    • info

      api operation id findAllTuples_130 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

Some revisions have not been checked yet.