BLbluestaq
Site

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

idSitestring

The ID of the site associated with the drop zone.

extIdentifierstring

The external identifier assigned to the drop zone.

namestring required

The name of the drop zone.

codestring

The type code for the drop zone.

pointNamestring

The name assigned to the drop zone point.

zarIdstring

The identifier of the Zone Availability Report (ZAR) for the drop zone.

latnumber double required

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

lonnumber double required

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

lengthnumber double

The length dimension of the drop zone in meters for non-circular drop zones.

widthnumber double

The width dimension of the drop zone in meters for non-circular drop zones.

radiusnumber double

The radius dimension of the drop zone in meters for circular drop zones.

majcomstring

The Major Command (MAJCOM) responsible for management of the drop zone.

countryCodestring

The Country Code where the drop zone is located. 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 of the location for the drop zone.

altCountryCodestring

Specifies an alternate country code for the drop zone if the data provider code is not part of an official Country Code standard such as ISO-3166 or FIPS. This field will be set to the value provided by the source and should be used for all Queries specifying a Country Code.

altCountryNamestring

Specifies the country name associated with the source provided alternate country code.

stateAbbrstring

The US alphabetical code for the state where the drop zone is located.

stateNamestring

The name of the state where the drop zone is located.

surveyDatestring date-time

The date the drop zone survey was performed, in ISO 8601 UTC format with millisecond precision.

approvalDatestring date-time

The date the drop zone survey was approved, in ISO 8601 UTC format with millisecond precision.

operationalApprovalDatestring date-time

The approval date for the drop zone by an air drop authority certifying operational usage, in ISO 8601 UTC format with millisecond precision.

recertDatestring date-time

The date the drop zone was recertified, in ISO 8601 UTC format with millisecond precision.

expirationDatestring date-time

The survey expiration date of the drop zone, in ISO 8601 UTC format with millisecond precision.

nearestLocstring

The nearest reference location to the drop zone.

remarkstring

Remarks concerning the drop zone.

lastUpdatestring date-time

Last time the drop zone information was updated, in ISO 8601 UTC format with millisecond precision.

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 last 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": "3f28f60b-3a50-2aef-ac88-8e9d0e39912b",
    "classificationMarking": "U",
    "idSite": "a150b3ee-884b-b9ac-60a0-6408b4b16088",
    "extIdentifier": "1001",
    "name": "Viper DZ",
    "code": "DZ",
    "pointName": "CENTER POINT",
    "zarId": "1001",
    "lat": 33.54,
    "lon": -117.162,
    "length": 549.1,
    "width": 549.1,
    "radius": 495.1,
    "majcom": "United States Northern Command",
    "countryCode": "US",
    "countryName": "United States",
    "altCountryCode": "USA",
    "altCountryName": "United States of America",
    "stateAbbr": "CA",
    "stateName": "CALIFORNIA",
    "surveyDate": "2017-12-09T16:00:00.123Z",
    "approvalDate": "2018-01-05T16:00:00.123Z",
    "operationalApprovalDate": "2018-01-05T16:00:00.123Z",
    "recertDate": "2022-07-05T16:00:00.123Z",
    "expirationDate": "2022-12-09T16:00:00.123Z",
    "nearestLoc": "March AFB",
    "remark": "The text of the remark.",
    "lastUpdate": "2022-11-07T18:44:41.123Z",
    "createdAt": "2022-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2022-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

Some revisions have not been checked yet.