BLbluestaq
Weather

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

obTimestring date-time required

Datetime when a weather observation was made or forecast was issued in ISO 8601 UTC datetime format with microsecond precision. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

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.

idSensorstring

Unique identifier of the sensor making the weather measurement.

origSensorIdstring

Optional identifier provided by the record source. This may be an internal identifier and not necessarily a valid sensor ID.

weatherIdstring

Identifier of the weather over target, which should remain the same on subsequent Weather Over Target records.

idGroundImagerystring

Identifier of the ground imagery associated for this weather over target report.

idSitestring

Identifier of the Site that is associated with this weather report.

idAirfieldstring

Identifier of the Airfield associated with this weather report.

icaostring

The International Civil Aviation Organization (ICAO) code of the airfield associated with this weather report.

externalIdstring

Optional observation or forecast 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.

externalLocationIdstring

Optional location 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.

reportTypestring required

Identifies the type of weather report (e.g. OBSERVATION, FORECAST, etc.).

obTimestring date-time required

Datetime when a weather observation was made or forecast was issued in ISO 8601 UTC datetime format with microsecond precision.

forecastStartTimestring date-time

Valid start time of a weather forecast in ISO 8601 UTC datetime format with millisecond precision.

forecastEndTimestring date-time

Valid end time of a weather forecast in ISO 8601 UTC datetime format with millisecond precision.

latnumber double required

The central WGS-84 latitude of the weather report, in degrees. -90 to 90 degrees (negative values south of equator).

lonnumber double required

The central WGS-84 longitude of the weather report, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

altnumber double

Point height above ellipsoid (WGS-84), in meters.

geoPotentialAltnumber double

Altitude of a pressure surface in the atmosphere above mean sea level, in meters.

dataLevelstring

Specific pressures or heights where measurements are taken, labeled as either MANDATORY or SIGNIFICANT levels. Mandatory levels are at particular pressures at geopotential heights. Significant levels are at particular geometric heights.

areastring

Optional geographical region or polygon (lat/lon pairs) of the area surrounding the point of interest as projected on the ground.

atextstring

Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known Text representation of the geometry/geography, of the image as projected on the ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored if included with a POST or PUT request that also specifies a valid 'area' field.

agjsonstring

Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON representation of the geometry/geography, of the image as projected on the ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST or PUT request that also specifies a valid 'area' or 'atext' field.

atypestring

Type of region as projected on the ground.

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

windSpdnumber double

Expresses the speed of the wind in meters/second.

windSpdAvgnumber double

Average wind speed over a 1 minute period, in meters/second.

windGustnumber double

Expresses the max gust speed of the wind, in meters/second.

windGust10number double

Expresses the max gust speed of the wind recorded in a 10 minute period, in meters/second.

vshearnumber double

The change in wind speed between two different altitudes divided by the vertical distance between them, in units of 1/sec.

hshearnumber double

The change in wind speed between two different lateral positions at a given altitude divided by the horizontal distance between them, in units of 1/sec.

radVelnumber double

Average radial velocity of wind as measured by radar with multi-beam configurations. Radial velocity is the component of wind velocity moving directly toward or away from a sensor's radar beam, in meters per second. Values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar).

radVelBeam1number double

Component of wind velocity moving directly toward or away from radar beam 1, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source.

radVelBeam2number double

Component of wind velocity moving directly toward or away from radar beam 2, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source.

radVelBeam3number double

Component of wind velocity moving directly toward or away from radar beam 3, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source.

radVelBeam4number double

Component of wind velocity moving directly toward or away from radar beam 4, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source.

radVelBeam5number double

Component of wind velocity moving directly toward or away from radar beam 5, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source.

windDirnumber double

Direction the wind is blowing, in degrees clockwise from true north.

windDirAvgnumber double

Average wind direction over a 1 minute period, in degrees clockwise from true north.

windDirPeaknumber double

Wind direction corresponding to the peak wind speed during a 1 minute period, in degrees clockwise from true north.

windDirPeak10number double

Wind direction corresponding to the peak wind speed during a 10 minute period, in degrees clockwise from true north.

windChillnumber double

The perceived temperature in degrees C.

dirDevnumber double

The difference in wind direction recorded over a period of time, in degrees.

windVarboolean

Boolean describing whether or not the wind direction and/or speed is variable.

windCovnumber[]

Covariance matrix, in knots and second based units. The array values represent the lower triangular half of the covariance matrix. The size of the covariance matrix is 2x2. The covariance elements are position dependent within the array with values ordered as follows:

          x    y

x         1

y         2    3

The cov array should contain only the lower left triangle values from top left down to bottom right, in order.

cloudCoverstring[]

Array of cloud cover descriptions - each element can be maximum of 16 characters long. Intended as, but not constrained to, MIL-STD-6016 cloud cover designations (e.g. SKY CLEAR, SCATTERED, BROKEN, OVERCAST, SKY OBSCURED). Each element of the array corresponds to the elements in the cloudHght array specified respectively.

cloudHghtnumber[]

Array of cloud base heights in meters described by the cloudHght array. Each element of the array corresponds to the elements in the cloudCover array specified respectively.

actWeatherstring

Describes the actual weather at position. Intended as, but not constrained to, MIL-STD-6016 actual weather (e.g. NO STATEMENT, NO SIGNIFICANT WEATHER, DRIZZLE, RAIN, SNOW, SNOW GRAINS, DIAMOND DUST, ICE PELLETS, HAIL, SMALL HAIL, MIST, FOG, SMOKE, VOLCANIC ASH, WIDESPREAD DUST, SAND, HAZE, WELL DEVELOPED DUST, SQUALLS, FUNNEL CLOUDS, SANDSTORM, DUSTSTORM, LOW CLOUDS, CLOUDY, GROUND FOG, DUST, HEAVY RAIN, THUNDERSTORMS AWT, HEAVY THUNDERSTORMS, HURRICANE TYPHOON CYCLONE, TROPICAL STORM, TORNADO, HIGH WINDS, LIGHTNING, FREEZING DRIZZLE, FREEZING RAIN, HEAVY SNOW, ICING, SNOW OR RAIN AND SNOW MIXED, SHOWERS, CLEAR).

weatherDescstring

Used in conjunction with actWeather and weatherInt. Intended as, but not constrained to, MIL-STD-6016 actual weather descriptor (e.g. NO STATEMENT, SHALLOW, PATCHES, LOW DRIFTING, BLOWING, SHOWERS, THUNDERSTORMS, SUPERCOOLED).

weatherIntstring

Weather Intensity. Used in conjunction with actWeather and weatherDesc. Intended as, but not constrained to, MIL-STD-6016 weather intensity (e.g. NO STATEMENT, LIGHT, MODERATE, HEAVY, IN VICINITY).

rawMETARstring

The Raw Meteorological Aerodrome Report (METAR) string.

rawTAFstring

Terminal Aerodrome Forecast (TAF) containing detailed weather predictions for a specific airport or aerodrome.

qnhnumber double

Altimeter set to read zero at mean sea level in kilopascals.

visibilitynumber double

Visual distance in meters.

temperaturenumber double

The measurement of air temperature in degrees C.

soilTempnumber double

The measurement of soil temperature in degrees C.

barPressnumber double

The measurement of air pressure in the atmosphere in kilopascals.

precipRatenumber double

The speed at which water is being applied to a specific area in millimeters per hour.

rainHournumber double

The amount of rain that has fallen in the past hour, in centimeters.

solarRadnumber double

The power per unit area received from the Sun in the form of electromagnetic radiation as measured in the wavelength range of the measuring instrument. The solar irradiance is measured in watt per square meter (W/m2).

difRadnumber double

The amount of radiation that reaches earth's surface after being scattered by the atmosphere, in Watts per square meter.

refRadnumber double

The amount of radiation that changes direction as a function of atmospheric density, in Watts per square meter.

senlatnumber double

Sensor WGS84 latitude at obTime in degrees. -90 to 90 degrees (negative values south of equator). This includes pilot reports or other means of weather observation.

senlonnumber double

Sensor WGS84 longitude at obTime in degrees. -180 to 180 degrees (negative values west of Prime Meridian). This includes pilot reports or other means of weather observation.

senaltnumber double

Sensor altitude at obTime in km. This includes pilot reports or other means of weather observation.

dewPointnumber double

The temperature at which air is saturated with water vapor, in degrees C.

relHumiditynumber double

The percentage of water vapor in the atmosphere.

indexRefractionnumber double

An indication of how much the atmosphere refracts light.

soilMoisturenumber double

The volumetric percentage of soil water contained in a given volume of soil.

surroundingWeatherstring

Describes in which direction (if any) that better weather conditions exist. Intended as, but not constrained to, MIL-STD-6016 surrounding weather designations (e.g. NO STATEMENT, BETTER TO NORTH, BETTER TO EAST, BETTER TO SOUTH, BETTER TO WEST).

weatherAmpstring

Amplifies the actual weather being reported. Intended as, but not constrained to, MIL-STD-6016 weather amplification designations (e.g. NO STATEMENT, NO SCATTERED BROKEN MEDIUM CLOUD, SCATTERED BROKEN MEDIUM CLOUDS, GUSTY WINDS AT SERVICE, FOG IN VALLEYS, HIGHER TERRAIN OBSCURED, SURFACE CONDITIONS VARIABLE, SURFACE WIND NE, SURFACE WIND SE, SURFACE WIND SW, SURFACE WIND NW, PRESENCE OF CUMULONIMBUS).

contrailHghtLowernumber double

Reports the lowest altitude at which contrails are occurring, in meters.

contrailHghtUppernumber double

Reports the highest altitude at which contrails are occurring, in meters.

icingUpperLimitnumber double

Reports the highest altitude at which icing or freezing rain is occurring, in meters.

icingLowerLimitnumber double

Reports the lowest altitude at which icing or freezing rain is occurring, in meters.

enRouteWeatherstring

Describes the flight conditions in route to the target (NO STATEMENT, MAINLY IFR, MAINLY VFR, THUNDERSTORMS).

MAINLY IFR: Predominantly Instrument Flight Rules.

MAINLY VFR: Predominantly Visual Flight Rules.

THUNDERSTORMS: Thunderstorms expected in route.

ccEventboolean

Flag indicating detection of a cloud-to-cloud lightning event.

srcTypsstring[]

Array of UDL record types (SENSOR, WEATHERDATA) that are related to this WeatherReport record. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size.

srcIdsstring[]

Array of UUID(s) of the UDL data record(s) that are related to this WeatherReport record. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. See the corresponding srcTyps array element for the data type of the UUID and use the appropriate API operation to retrieve that object.

origNetworkstring

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

createdAtstring date-time

Time the row was created in the database.

createdBystring

Application user who created the row in the database.

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.

Example response

[
  {
    "id": "WEATHER-REPORT-ID",
    "classificationMarking": "U",
    "idSensor": "0129f577-e04c-441e-65ca-0a04a750bed9",
    "origSensorId": "ORIGSENSOR-ID",
    "weatherId": "WEATHER-ID",
    "idGroundImagery": "GROUND-IMAGERY-ID",
    "idSite": "AIRFIELD-ID",
    "idAirfield": "8fb38d6d-a3de-45dd-8974-4e3ed73e9449",
    "icao": "KAFF",
    "externalId": "GDSSMB022408301601304517",
    "externalLocationId": "TMDS060AD4OG03CC",
    "reportType": "FORECAST",
    "obTime": "2018-01-01T16:00:00.123456Z",
    "forecastStartTime": "2024-01-01T16:00:00.123Z",
    "forecastEndTime": "2024-01-01T18:00:00.123Z",
    "lat": 56.12,
    "lon": -156.6,
    "alt": 123.12,
    "geoPotentialAlt": 1000,
    "dataLevel": "MANDATORY",
    "area": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
    "atext": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
    "agjson": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 67.3291113966927, 26.156175339112 ], [ 67.2580009640721, 26.091022064271 ], [ 67.1795862381682, 26.6637992964562 ], [ 67.2501237475598, 26.730115808233 ], [ 67.3291113966927, 26.156175339112 ] ] ] }",
    "atype": "ST_Polygon",
    "andims": 2,
    "asrid": 4326,
    "windSpd": 1.23,
    "windSpdAvg": 12.1,
    "windGust": 10.23,
    "windGust10": 13.2,
    "vshear": 3.8,
    "hshear": 3.8,
    "radVel": -0.04,
    "radVelBeam1": 4.4,
    "radVelBeam2": -0.2,
    "radVelBeam3": -0.2,
    "radVelBeam4": 11.4,
    "radVelBeam5": 4.1,
    "windDir": 75.1234,
    "windDirAvg": 57.1,
    "windDirPeak": 78.4,
    "windDirPeak10": 44.5,
    "windChill": 15.6,
    "dirDev": 9.1,
    "windCov": [
      1.1,
      2.2
    ],
    "cloudCover": [
      "OVERCAST",
      "BROKEN"
    ],
    "cloudHght": [
      1.2,
      2.2
    ],
    "actWeather": "NO STATEMENT",
    "weatherDesc": "NO STATEMENT",
    "weatherInt": "NO STATEMENT",
    "rawMETAR": "KXYZ 241456Z 19012G20KT 10SM FEW120 SCT200 BKN250 26/M04 A2981 RMK AO2 PK WND 19026/1420 SLP068 T02611039 51015",
    "rawTAF": "KXYZ 051730Z 0518/0624 31008KT 3SM -SHRA BKN020 FM052300 30006KT 5SM -SHRA OVC030 PROB30 0604/0606 VRB20G35KT 1SM TSRA BKN015CB FM060600 25010KT 4SM -SHRA OVC050 TEMPO 0608/0611 2SM -SHRA OVC030 RMK NXT FCST BY 00Z=",
    "qnh": 1234.456,
    "visibility": 1234.456,
    "temperature": 23.45,
    "soilTemp": 22.4,
    "barPress": 101.2,
    "precipRate": 3.4,
    "rainHour": 1.2,
    "solarRad": 1234.456,
    "difRad": 234.5,
    "refRad": 56.7,
    "senlat": 12.456,
    "senlon": 123.456,
    "senalt": 1.23,
    "dewPoint": 15.6,
    "relHumidity": 34.456,
    "indexRefraction": 1.1,
    "soilMoisture": 3.5,
    "surroundingWeather": "NO STATEMENT",
    "weatherAmp": "NO STATEMENT",
    "contrailHghtLower": 123.123,
    "contrailHghtUpper": 123.123,
    "icingUpperLimit": 123.123,
    "icingLowerLimit": 123.123,
    "enRouteWeather": "THUNDERSTORMS",
    "ccEvent": true,
    "srcTyps": [
      "SENSOR",
      "WEATHERDATA"
    ],
    "srcIds": [
      "e609a90d-4059-4043-9f1a-fd7b49a3e1d0",
      "c739fcdb-c0c9-43c0-97b6-bfc80d0ffd52"
    ],
    "origNetwork": "OPS1",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST"
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the / response property's maxLength was increased from 512 to 1024 for the response status

    • breaking

      the / response property's maxLength was increased from 1024 to 2048 for the response status

  • 45631f9bb3f0Revision changes
    • info

      the response optional property / became write-only for the status

Some revisions have not been checked yet.