BLbluestaq
Weather

GET /udl/weatherdata

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

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

Query parameters

obTimestring date-time required

Datetime of the weather observation 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.

obTimestring date-time required

Datetime of the weather observation in ISO 8601 UTC datetime format with microsecond precision.

sigPwrsnumber[]

Array of signal power(s) measured by the sensor, in decibels. Users should consult the data provider for information on the signal powers array structure.

noiseLvlsnumber[]

Array of noise level(s) measured by radar, in decibels. Users should consult the data provider for information on the noise levels array structure.

specWidthsnumber[]

Array of width(s) of the distribution in Doppler velocity measured by radar, in meters/second. Spectral width depends on the particle size distribution, the wind shear across the radar beam, and turbulence. Users should consult the data provider for information on the spectral widths array structure.

firstGuessAvgsinteger[]

Array of average maximum number(s) of consecutive instances in which the same first guess velocity is used in radar data processing to estimate wind speed. Users should consult the data provider for information on the first guess averages array structure.

qcValueinteger

Quality control flag value, as defined by the data provider.

fileCreationstring date-time

Datetime the system files were created.

termAltnumber double

Last altitude with recorded measurements in this record, in meters.

avgTxPwrnumber double

Average transmitted power of the radar, in kilowatts.

avgRefPwrnumber double

Average power of the reflected signal received by the radar, in Watts.

sectorNuminteger

Number of sectors within the radar coverage area, each containing a number of antennas.

numElementsinteger

Number of antennas across all sectors within the radar coverage area.

tdAvgSampleNumsinteger[]

Array of the number(s) of radar samples used in time domain averaging for radar data processing. Time domain averaging improves the quality of the measured signal by reducing random noise and enhancing the signal-to-noise ratio. Users should consult the data provider for information on the time domain sample numbers array structure.

checksuminteger

Checksum value for the data.

coIntegsinteger[]

Array of the number(s) of measurements used in coherent integrations used for radar data processing. Users should consult the data provider for information on the coherent integrations array structure.

specAvgsinteger[]

Array of the number(s) of spectral averages used in radar data processing. Users should consult the data provider for information on the spectral averages array structure.

interpulsePeriodsnumber[]

Array of the elapsed time(s) from the beginning of one pulse to the beginning of the next pulse for a radar beam, in microseconds. Users should consult the data provider for information on the interpulse periods array structure.

doppVelsnumber[]

Array of full scale Nyquist Doppler velocities measured by radar, in meters per second. Nyquist velocity refers to the maximum velocity magnitude that the radar system can unambiguously detect. Doppler velocities with absolute values exceeding the Nyquist threshold suffer from aliasing at the time of collection. Users should consult the data provider for information on the doppler velocities array structure.

consRecsinteger[]

Array of the number(s) of records in consensus for a radar beam. Users should consult the data provider for information on the consensus records array structure.

snrsnumber[]

Array of signal to noise ratio(s) for a radar beam, in decibels. Users should consult the data provider for information on the signal to noise ratios array structure.

sigStrengthnumber double

Signal strength of the electromagnetic energy received due to a lightning event, in kiloamps.

semiMajorAxisnumber double

Semi-major axis of the 50% positional confidence ellipse, in kilometers.

semiMinorAxisnumber double

Semi-minor axis of the 50% positional confidence ellipse, in kilometers.

angleOrientationnumber double

Angle of orientation of the 50% positional confidence ellipse, in degrees clockwise from true north.

lightEventNuminteger

Number of sensors used in the lightning event location solution.

lightDetSensorsinteger[]

Array of sensor(s) that participated in the lightning event location determination.

posConfidencenumber double

The positional confidence of the calculated lightning event location using the chi-square statistical method.

srcTypsstring[]

Array of UDL record types (SENSOR, WEATHERREPORT) that are related to this WeatherData 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 WeatherData 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-DATA-ID",
    "classificationMarking": "U",
    "idSensor": "0129f577-e04c-441e-65ca-0a04a750bed9",
    "origSensorId": "ORIGSENSOR-ID",
    "obTime": "2018-01-01T16:00:00.123456Z",
    "sigPwrs": [
      116.5,
      121.6
    ],
    "noiseLvls": [
      58.2,
      58.3
    ],
    "specWidths": [
      0.3,
      0.6
    ],
    "firstGuessAvgs": [
      16,
      1
    ],
    "qcValue": 4,
    "fileCreation": "2018-01-01T16:00:00.123456Z",
    "termAlt": 19505.1,
    "avgTxPwr": 20.23,
    "avgRefPwr": 714.9,
    "sectorNum": 20,
    "numElements": 640,
    "tdAvgSampleNums": [
      32,
      30
    ],
    "checksum": 133,
    "coIntegs": [
      4,
      3
    ],
    "specAvgs": [
      4,
      3
    ],
    "interpulsePeriods": [
      1000.3,
      1000.2
    ],
    "doppVels": [
      44.4,
      467.3
    ],
    "consRecs": [
      5,
      2
    ],
    "snrs": [
      14.5,
      -16.2
    ],
    "sigStrength": 163.7,
    "semiMajorAxis": 3.4,
    "semiMinorAxis": 0.3,
    "angleOrientation": 75.7,
    "lightEventNum": 9,
    "lightDetSensors": [
      11,
      28,
      190
    ],
    "posConfidence": 0.1,
    "srcTyps": [
      "SENSOR",
      "WEATHERREPORT"
    ],
    "srcIds": [
      "1b23ba93-0957-4654-b5ca-8c3703f3ec57",
      "32944ee4-0437-4d94-95ce-2f2823ffa001"
    ],
    "origNetwork": "OPS1",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAll_137 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.