BLbluestaq
Observation

GET /udl/monoradar

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/monoradar
  • Auth
    none declared

Query parameters

tsstring date-time required

Target detection time, in ISO 8601 UTC 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.

ttistring

Test target indicator.

idSensorstring

ID of the radar site or station providing the data.

senlatnumber double

Sensor WGS84 latitude, in degrees, at time of observation (ts). -90 to 90 degrees (negative values south of equator).

senlonnumber double

Sensor WGS84 longitude, in degrees, at time of observation (ts). -180 to 180 degrees (negative values west of Prime Meridian).

senaltnumber double

Sensor altitude, in kilometers, at time of observation (ts).

sacinteger

System Area Code.

sicinteger

System Identification Code.

tgtidstring

Aircraft identification from an aircraft equipped with a Mode S transponder.

addrstring

Aircraft address (24-bits Mode S address) assigned uniquely to each aircraft.

msgfmtstring required

Message format received (i.e. 'ASR9', 'CAT48', 'TPS70', etc..).

msgtypstring required

Message report type received (i.e. 'SRCH', 'BCN', 'REINF', 'BRTQC', 'PSR', etc..).

afboolean

Flag indicating military message.

faaboolean

Flag indicating FAA/Civ message.

spiboolean

Flag indicating whether Special Position Indicator (SPI) present in interrogation response.

aimsboolean

Flag indicating whether AIMS present.

mtiboolean

Flag indicating that target was detected using data from an MTI receiver.

bcnhitsinteger

Number of beacon hits received on the target.

tsstring date-time required

Target detection time, in ISO 8601 UTC format with microsecond precision.

msgtsstring date-time required

Message time, in ISO 8601 UTC format with microsecond precision. This is the time that the data message was released from the site.

rngnumber double

Measured slant range to target from the observing site, in km.

aznumber double

Target azimuth, measured from the observing site, in degrees from true North. If Azimuth Change Pulse (acp) count is provided, az represents the computed angle.

acpinteger

Azimuth Change Pulse count at target detection.

alt3dnumber double

Measured height of the target, in km. (for 3D radars).

mcnumber double

Mode-C altitude (uncorrected pressure altitude), in km.

mcvstring

Status of the mode-C validity bit.

mcgboolean

Indicator that the mode-C response was garbled.

m1string

Mode-1 interrogation response (mission code).

m1vstring

Status of the mode-1 validity bit.

m1gboolean

Indicator that the mode-1 response was garbled.

m2string

Mode-2 interrogation response (military identification code).

m2vstring

Status of the mode-2 validity bit.

m2xvstring

Status of the mode-2 X-Pulse response validation.

m2gboolean

Indicator that the mode-2 response was garbled.

m3astring

Mode-3/A interrogation response (aircraft identification).

m3avstring

Status of the mode-3/A validity bit.

m3agboolean

Indicator that the mode-3/A response was garbled.

m3axvstring

Status of the mode-3 X-Pulse response validation.

m4string

Mode-4 interrogation response (Identification Friend/Foe).

m4vstring

Status of the mode-4 validity bit.

m4d1d2string

Mode-4 D1 & D2 response status.

mscommbstring

Mode-S Comm B message data.

milemrgcyboolean

Flag indicating military emergency.

code7500boolean

7500 squawk present (hijack).

code7600boolean

7600 squawk present (loss of comm).

code7700boolean

7700 squawk present (general emergency).

grndspdnumber double

Target ground speed, in meters/second.

hdngnumber double

Target heading, in degrees from true North at the target position.

trknuminteger

Value representing a unique reference to a track record within a particular track file. Included when the radar station outputs tracks.

radstring

Type of sensor(s) maintaining track.

mahstring

Indication of Horizontal Maneuver detection.

cdmstring

Climbing/Descending mode indicator.

cartposnumber[]

Array of local 2d-cartesian [x, y] coordinates of target, in km.

psrrlnumber double

Runlength of the primary surveillance radar track, in degrees.

ssrlnumber double

Runlength of the secondary surveillance radar track, in degrees.

rngdeltnumber double

Target range delta between PSR and SSR (reference PSR-SSR), in km.

azdeltnumber double

Target azimuth delta between PSR and SSR (reference PSR-SSR), in degrees.

wectcstring[]

Warning/Error Conditions and Target Classification.

mrgrptboolean

Flag indicating report separated from different responses at same range. Azimuth may have larger than normal error when present.

artsqualstring

ARTS quality.

trkeligstring

Track eligibility flag.

tgtconfstring

Target confidence.

tgtcorrstring

Target correlation flag.

tisnumber double

Data time-in-storage, in seconds. This is the amount of time elapsed between target detection and message transmission.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

origSensorIdstring

Optional identifier provided by observation source to indicate the sensor identifier which produced this observation.This may be an internal identifier and not necessarily a valid sensor ID.

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.

createdAtstring date-time

Time the row was created in the database.

createdBystring

Application user who created the row in the database.

origNetworkstring

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

Example response

[
  {
    "id": "MONORADAR-ID",
    "classificationMarking": "U",
    "tti": "TTI",
    "idSensor": "REF-SENSOR-ID",
    "senlat": 45.23,
    "senlon": 45.23,
    "senalt": 100.23,
    "sac": 10,
    "sic": 40,
    "tgtid": "TGT-ID",
    "addr": "ADDR-ID",
    "msgfmt": "CAT48",
    "msgtyp": "BCN",
    "af": true,
    "faa": true,
    "spi": true,
    "aims": true,
    "mti": true,
    "bcnhits": 12,
    "ts": "2021-01-01T01:01:01.123456Z",
    "msgts": "2021-01-01T01:01:01.123456Z",
    "rng": 100.23,
    "az": 100.23,
    "acp": 100,
    "alt3d": 100.23,
    "mc": 100.23,
    "mcv": "MCV",
    "mcg": true,
    "m1": "MISSION_CODE",
    "m1v": "M1V",
    "m1g": true,
    "m2": "MILITARY_ID_CODE",
    "m2v": "M2V",
    "m2xv": "M2XV",
    "m2g": true,
    "m3a": "AIRCRAFT_ID",
    "m3av": "M3AV",
    "m3ag": true,
    "m3axv": "M3AXV",
    "m4": "ID_FRIEND",
    "m4v": "M4V",
    "m4d1d2": "STATUS",
    "mscommb": "MSCOMMB",
    "grndspd": 30.23,
    "hdng": 30.23,
    "trknum": 30,
    "rad": "RAD",
    "mah": "MAH",
    "cdm": "CDM",
    "cartpos": [
      1.2,
      2.2
    ],
    "psrrl": 44.23,
    "ssrl": 44.23,
    "rngdelt": 44.23,
    "azdelt": 44.23,
    "wectc": [
      "WARNING",
      "WARNING"
    ],
    "mrgrpt": true,
    "artsqual": "QUALITY",
    "trkelig": "ELIGIBILITY",
    "tgtconf": "CONFIDENCE",
    "tgtcorr": "CORRELATION",
    "tis": 0.4,
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "origSensorId": "ORIGSENSOR-ID",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "origNetwork": "OPS1"
  }
]

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_65 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.