BLbluestaq
Observation

GET /udl/gnssobservationset/history

Changed on

Service operation to dynamically query historical 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/gnssobservationset/history
  • Auth
    none declared

Query parameters

columnsstring

optional, fields for retrieval. When omitted, ALL fields are assumed. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid query fields that can be selected.

tsstring date-time required

Observation Time, in ISO8601 UTC format with microsecond precision. This timestamp applies to all observations within the set. (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.

markerTypestring

The marker type of the observing receiver (AIRBORNE, ANIMAL, BALLISTIC, FIXED BUOY, FLOATING BUOY, FLOATING ICE, GEODETIC, GLACIER, GROUNDCRAFT, HUMAN, NON GEODETIC, NON PHYSICAL, SPACEBORNE, WATERCRAFT). Reference RINEX 3+ for further information concerning marker types.

idOnOrbitstring

Unique identifier of the primary satellite on-orbit object.

satNointeger

Satellite/catalog number of the target on-orbit object.

origObjectIdstring

Optional identifier provided by ephemeris source to indicate the target object of this ephemeris. This may be an internal identifier and not necessarily map to a valid satellite number.

tsstring date-time required

Observation Time, in ISO8601 UTC format with microsecond precision. This timestamp applies to all observations within the set.

outageinteger

Time, in seconds, that the receiver has been unable to compute a GNSS fix.

gDopnumber double

Geometric Dilution of Precision.

hDopnumber double

Horizontal Dilution of Precision.

pDopnumber double

Position Dilution of Precision.

tDopnumber double

Time Dilution of Precision.

vDopnumber double

Vertical Dilution of Precision.

eventIdstring

Optional source-provided identifier for this collection event. This field can be used to associate records related to the same event.

esIdstring

Unique identifier of the parent Ephemeris Set, if this data is correlated with an Ephemeris. If reporting for a spacecraft with multiple onboard GNSS receivers, this ID may be associated with multiple GNSS Observation records if each receiver is synced to the ephemeris points.

receiverstring

The number or ID of the GNSS receiver associated with this data. Each GNSS Observation Set is associated with only one receiver. If reporting for multiple receivers a separate set should be generated for each. A null value is assumed to indicate that only one receiver is present, or reported.

boresightnumber[]

unit vector of the outward facing direction of the receiver boresight in a body-fixed coordinate system.

quatnumber[]

The quaternion describing the rotation of the body-fixed frame used for this system into the local geodetic frame, at observation time (ts). The array element order convention is scalar component first, followed by the three vector components. For a vector u in the body-fixed frame, the corresponding vector u' in the geodetic frame should satisfy u' = quq*, where q is this quaternion.

latnumber double

WGS-84 spacecraft latitude sub-point at observation time (ts), represented as -90 to 90 degrees (negative values south of equator).

lonnumber double

WGS-84 spacecraft longitude sub-point at observation time (ts), represented as -180 to 180 degrees (negative values west of Prime Meridian).

altnumber double

Spacecraft altitude at observation time (ts), expressed in kilometers above WGS-84 ellipsoid.

satPositionnumber[]

Three element array, expressing the ECI J2K spacecraft position components, in kilometers, at observation time (ts). The array element order is [x, y, z].

satVelocitynumber[]

Three element array, expressing the ECI J2K spacecraft velocity components, in km/second, at observation time (ts). The array element order is [xvel, yvel, zvel].

obsCodesstring[]

Array of the strings containing the individual observation code sets that are contained within this GNSS Observation set. Each string is a three-character representation of the measurement type, the channel, and the coding, in compliance with the RINEX 3+ standard (Pseudorange (C), Carrier Phase (L), Doppler (D), Signal Strength C/No (S), or Channel Number (X)). See the GNSS Observation ob field for the units of measure associated with each observation type.

trackingStatusinteger

Status of the GNSS receiver signal. Status options are 0, 1 or 2 (0 being the best).

navigationStatusstring

The current navigation status as defined by the data source. In general the navigation status specifies whether the signal is normal, degraded, or unavailable. For status value definitions please reach out to data source provider.

agcStateinteger

GNSS Automatic Gain Control State.

srcTypsstring[]

Array of UDL record types (AIS, CONJUNCTION, DOA, ELSET, EO, ESID, GROUNDIMAGE, POI, MANEUVER, MTI, NOTIFICATION, RADAR, RF, SIGACT, SKYIMAGE, SV, TRACK) that are related to this GNSS Observation Set. 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 UUIDs of the UDL data records that are related to this GNSS Observation Set. 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 (e.g. /udl/statevector/{uuid}).

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.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

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.

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.

origNetworkstring

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

Example response

[
  {
    "id": "GNSSObSet-ID",
    "classificationMarking": "U",
    "markerType": "SPACEBORNE",
    "idOnOrbit": "ONORBIT-ID",
    "satNo": 2,
    "origObjectId": "ORIGOBJECT-ID",
    "ts": "2022-01-01T00:00:00.123456Z",
    "outage": 200,
    "gDop": 0.33,
    "hDop": 0.03,
    "pDop": 0.002,
    "tDop": 0.05,
    "vDop": 0.03,
    "eventId": "2f2205c9-7bc2-4e1a-8416-2f80cc71f64b",
    "esId": "ES-ID",
    "receiver": "RECEIVER-ID",
    "boresight": [
      1.23,
      3.23
    ],
    "quat": [
      0.03,
      0.02,
      0.01,
      0.012
    ],
    "lat": 32.021,
    "lon": 125.123,
    "alt": 200,
    "satPosition": [
      1625.71954,
      6782.15396,
      -1721.34267
    ],
    "satVelocity": [
      2.03,
      0.003,
      0.12
    ],
    "obsCodes": [
      "ACL"
    ],
    "navigationStatus": "degraded",
    "agcState": 20,
    "srcTyps": [
      "SV",
      "SV"
    ],
    "srcIds": [
      "SV_ID",
      "SV_ID"
    ],
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "transactionId": "TRANSACTION-ID",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1",
    "gnssObservationList": [
      {
        "gnssSatId": "GEJ",
        "agcState": 20,
        "obsCodeSet": [
          "S1C",
          "C1C",
          "C1D"
        ],
        "ob": [
          42.1,
          1000,
          0.9
        ]
      }
    ]
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the / response property's minItems was decreased from 2 to 0 for the response status

    • breaking

      the / response property's minItems was decreased from 4 to 0 for the response status

    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.