Observation

GET /udl/onboardnavigation

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

Query parameters

startTimestring date-time required

Start time of the sensor data, in ISO 8601 UTC format. (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.

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 the data source to indicate the target object of this record. This may be an internal identifier and not necessarily map to a valid satellite number.

startTimestring date-time required

Start time of the sensor data, in ISO 8601 UTC format.

endTimestring date-time

End time of the sensor data, in ISO 8601 UTC format.

esIdstring

Unique identifier of the parent EphemerisSet, if this data is correlated with an Ephemeris. If multiple nav sensor records are required, this ID may be associated with each of those records if each is synced to the ephemeris points.

starCatNamestring

The name or identifier the star catalog in use.

starCatLoadTimestring date-time

The last load time of the current star catalog onboard this spacecraft.

idStateVectorstring

Unique identifier of the last onboard state vector.

tsstring[]

Array of epochs of the observations, in ISO 8601 UTC format. The epochs are assumed to correspond to all sensor data in this record. If sensors do not share a common epoch then separate records should be generated.

referenceFrame'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF'

The reference frame in which the sensor derived positions are provided. If the referenceFrame is null it is assumed to be J2000. Note that this frame is assumed to apply to all of the sensor data in this record. If onboard sensors process positional estimates in different frames then separate records should be generated.

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.

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": "ONBOARD-NAVIGATION-ID",
    "classificationMarking": "U",
    "idOnOrbit": "ONORBIT-ID",
    "satNo": 101,
    "origObjectId": "ORIGOBJECT-ID",
    "startTime": "2021-07-20T01:02:03.123456Z",
    "endTime": "2021-07-20T01:02:03.123456Z",
    "esId": "EPHEMERISSET-ID",
    "starCatName": "STAR-CAT-NAME",
    "starCatLoadTime": "2021-07-21T01:02:03.123Z",
    "idStateVector": "STATE-VECTOR-ID",
    "ts": [
      "2021-07-21T01:02:03.120003Z"
    ],
    "referenceFrame": "J2000",
    "sunSensor": [
      [
        1.1,
        2.2,
        3.3
      ]
    ],
    "mag": [
      [
        1.1,
        2.2,
        3.3
      ]
    ],
    "starTracker": [
      [
        1.1,
        2.2,
        3.3
      ]
    ],
    "deltaPos": [
      [
        1.1,
        2.2,
        3.3
      ]
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

    • info

      api operation id findAll_72 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.