BLbluestaq
Onorbit

GET /udl/geostatus

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

Query parameters

createdAtstring date required

Time the row was created in the database, auto-populated by the system. (YYYY-MM-DDTHH:MM:SS.sssZ)

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 object on-orbit object.

origObjectIdstring

Optional identifier provided to indicate the target onorbit. This may be an internal identifier and not necessarily map to a valid satellite number.

ssnumber double

Sine of inclination times the sine of right ascension.

scnumber double

Sine of inclination times the cosine of right ascension.

relativeEnergynumber double

Objects displacement from geostationary orbit in deg^2/day^2.

longitudeRatenumber double

Corrective or overriding long term trend for longitudinal change in degrees/day.

longitudeMinnumber double

Minimum longitude for this object. WGS-84 longitude of the spacecraft position, in degrees. 0 to 360 degrees.

longitudeMaxnumber double

Maximum longitude for this object. WGS-84 longitude of the spacecraft position, in degrees. 0 to 360 degrees.

confidenceLevelstring

Indicates the confidence level in the entry. (Low, Medium, High).

planeChangeStatusstring

Geosynchronous plane changing status. (Current, Never, Former, Future).

troughTypestring

Indicates the trough (gravity well) or drift direction of a space object:

255 - Influenced by 255° longitude trough.

75 - Influenced by 75° longitude trough.

Both - Oscillating between both 255 and 75 troughs.

East - Drifting eastward; large relative energy and a period less than 1436.1 minutes.

West - Drifting westward; large relative energy and a period greater than 1436.2 minutes.

lostFlagboolean

Lost space object indicator. (True or False).

semiAnnualCorrFlagboolean

Semi-annual correction. (True or False).

objectStatusstring

Space object status. (Active, Dead, Unknown).

rawFileURIstring

Optional URI location in the document repository of the raw file parsed by the system to produce this record. To download the raw file, prepend https://udl-hostname/scs/download?id= to this value.

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.

satNointeger

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

origNetworkstring

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

Example response

[
  {
    "id": "GEOSTATUS-ID",
    "classificationMarking": "U",
    "idOnOrbit": "REF-ONORBIT-ID",
    "origObjectId": "ORIGOBJECT-ID",
    "ss": 1.1,
    "sc": 1.1,
    "relativeEnergy": 1.1,
    "longitudeRate": 1.1,
    "longitudeMin": 180.1,
    "longitudeMax": 1.01,
    "confidenceLevel": "Low",
    "planeChangeStatus": "Current",
    "troughType": "West",
    "objectStatus": "Active",
    "rawFileURI": "Example URI",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "satNo": 21,
    "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_42 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.