Report and Activity

GET /udl/emittergeolocation

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

Query parameters

startTimestring date-time required

The start time for this Emitter Geo Location data set in ISO 8601 UTC 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.

signalOfInterestTypestring required

Type of the signal of interest of this Emitter Geo Location (e.g. RF).

orderIdstring

The order identifier for this Emitter Geo Location data set.

createdTsstring date-time

Specifies the creation time associated with the order in ISO 8601 UTC with microsecond precision.

receivedTsstring date-time

The time representing the mean of the constituent single-burst observations in ISO 8601 UTC with microsecond precision.

startTimestring date-time required

The start time for this Emitter Geo Location data set in ISO 8601 UTC with microsecond precision.

endTimestring date-time

The end time for this Emitter Geo Location data set in ISO 8601 UTC with microsecond precision.

idOnOrbitstring

Unique identifier of the satellite used to identify and geolocate Emitter signals of interest. This ID can be used to obtain additional information on an OnOrbit object using the 'get by ID' operation (e.g. /udl/onorbit/{id}). For example, the onorbit object with idOnOrbit = abc would be queried as /udl/onorbit/abc. Used when Emitter geolocation is done by a single satellite.

satNointeger

Satellite/catalog number of the on-orbit spacecraft used to identify and geolocate Emitter signals of interest of this detection. Used when Emitter geolocation is done by a single satellite.

origObjectIdstring

Optional identifier of the satellite used to identify and geolocate Emitter signals of interest of this observation. This may be an internal identifier and not necessarily a valid satellite number. Used when Emitter geolocation is done by a single satellite.

idSensorstring

Unique identifier of the reporting sensor. This ID can be used to obtain additional information on a sensor using the 'get by ID' operation (e.g. /udl/sensor/{id}). For example, the sensor with idSensor = abc would be queried as /udl/sensor/abc. Used when Emitter geolocation is done by a single sensor.

origSensorIdstring

Optional identifier provided by observation source to indicate the sensor identifier which produced this Emitter Geo Location. This may be an internal identifier and not necessarily a valid sensor ID. Used when Emitter geolocation is done by a single sensor.

clusterstring

The name(s) of the subset of constellation spacecraft that made this detection.

constellationstring

The name of the satellite constellation.

signalOfIntereststring

The name of the signal of interest.

idRFEmitterstring

Optional identifier of the geolocated signal of interest RF Emitter for this observation. This ID can be used to obtain additional information on an RF Emitter object using the 'get by ID' operation (e.g. /udl/rfemitter/{id}). For example, the rfemitter object with idRFEmitter = abc would be queried as /udl/rfemitter/abc.

origRFEmitterIdstring

Optional identifier of the emitter of interest for this observation. This may be an internal identifier and not necessarily a valid emitter Id.

numBurstsinteger

The count of single-burst observations used for this geolocation observation.

minFreqnumber double

The minimum detected frequency in megahertz.

maxFreqnumber double

The maximum detected frequency in megahertz.

centerFreqnumber double

The detected signal frequency in megahertz.

minPRInumber double

Minimum pulse repetition interval of the emitter, measured in microseconds. The interval between the start of one pulse and the start of another.

maxPRInumber double

Maximum pulse repetition interval of the emitter, measured in microseconds. The interval between the start of one pulse and the start of another.

avgPRInumber double

Average pulse repetition interval of the emitter, measured in microseconds. The interval between the start of one pulse and the start of another.

minPRFnumber double

Minimum pulse repetition frequency of the emitter, measured in hertz. PRF is the number of pulses transmitted per second. This is the reciprocal of the maxPRI (Pulse Repetition Interval) value.

maxPRFnumber double

Maximum pulse repetition frequency of the emitter, measured in hertz. PRF is the number of pulses transmitted per second. This is the reciprocal of the minPRI (Pulse Repetition Interval) value.

avgPRFnumber double

Average pulse repetition frequency of the emitter, measured in hertz. PRF is the number of pulses transmitted per second. This is the reciprocal of the avgPRI (Pulse Repetition Interval) value.

minPWnumber double

Minimum pulse width of the emitter, measured in nanoseconds. This is the minimum duration of the pulse.

maxPWnumber double

Maximum pulse width of the emitter, measured in nanoseconds. This is the maximum duration of the pulse.

avgPWnumber double

Average pulse width of the emitter, measured in nanoseconds. This is the average duration of the pulse.

pulseShapestring

Describes the form of the emitted pulse and how its signal varies within the pulse duration (e.g. GAUSSIAN, RECTANGULAR, TRAPEZOIDAL, etc.).

detectLatnumber double

WGS-84 latitude of the most likely emitter location coordinate point, in degrees. -90 to 90 degrees (negative values south of equator).

detectLonnumber double

WGS-84 longitude of the most likely emitter location coordinate point, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

detectAltnumber double

The altitude relative to WGS-84 ellipsoid, in meters.

errEllpnumber[]

Confidence ellipsoid about the detection location [semi-major axis (meters), semi-minor axis (meters), orientation (degrees) measured clockwise (0-360 from true north)].

confAreanumber double

The area of the confidence ellipse specified in meters squared to contain the emitter with a 95% probability.

atypestring

Type of region as projected on the ground.

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.

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.

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

passGroupIdstring

Optional external identifier referencing the entity used in the calculation of the geolocation.

algVersionstring

The EmitterGeo algorithm type and version used in Emitter geolocation calculations.

externalIdstring

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

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.

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.

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.

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.

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": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "signalOfInterestType": "RF",
    "orderId": "155240",
    "createdTs": "2024-05-31T23:06:18.123456Z",
    "receivedTs": "2024-05-31T21:16:58.123456Z",
    "startTime": "2024-05-31T21:12:12.123456Z",
    "endTime": "2024-05-31T21:16:15.123456Z",
    "idOnOrbit": "HawkEye360-7",
    "satNo": 101,
    "origObjectId": "ORIGOBJECT-ID",
    "idSensor": "OCULUSA",
    "origSensorId": "ORIGSENSOR-ID",
    "cluster": "CONSTELLATION1-F",
    "constellation": "HawkEye360",
    "signalOfInterest": "GPS",
    "idRFEmitter": "026dd511-8ba5-47d3-9909-836149f87686",
    "origRFEmitterId": "12345678",
    "numBursts": 17,
    "minFreq": 1575.42,
    "maxFreq": 1575.42,
    "centerFreq": 1575.42,
    "minPRI": 1600.1,
    "maxPRI": 1602.1,
    "avgPRI": 1601.1,
    "minPRF": 624.18,
    "maxPRF": 624.96,
    "avgPRF": 624.57,
    "minPW": 400.1,
    "maxPW": 400.3,
    "avgPW": 400.2,
    "pulseShape": "RECTANGULAR",
    "detectLat": 41.172,
    "detectLon": 37.019,
    "detectAlt": 123.456,
    "errEllp": [
      1.23,
      2.34,
      3.45
    ],
    "confArea": 81577480.056,
    "atype": "MultiPolygon",
    "agjson": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 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))",
    "andims": 3,
    "asrid": 3,
    "passGroupId": "80fd25a8-8b41-448d-888a-91c9dfcd940b",
    "algVersion": "v1.0-3-gps_nb_3ball",
    "externalId": "780180925",
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "sourceDL": "AXE",
    "dataMode": "TEST"
  }
]

Changes

    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response 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

    • 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.