CitraClient.Schemas.OrbitalElementsResponse (citra_client v0.3.0)

View Source

Response containing orbital elements history for plotting.

Fields

  • :data_points — list of CitraClient.Schemas.OrbitalElementPoint.t() (API key: dataPoints) — Orbital element data points sorted by epoch
  • :end_before — DateTime.t() (API key: endBefore) — Query end time
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite ID queried
  • :start_after — DateTime.t() (API key: startAfter) — Query start time
  • :total_count — integer() (API key: totalCount) — Total number of data points

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.OrbitalElementsResponse{
  data_points: [CitraClient.Schemas.OrbitalElementPoint.t() | map() | nil],
  end_before: DateTime.t() | nil,
  satellite_id: String.t() | nil,
  start_after: DateTime.t() | nil,
  total_count: integer() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.