Screening

Create Screening

Changed on

Create a screening. Compares all points of the primary ephemerides which overlap in time with the resolved assigned secondaries, and identify close-approaches which may require the operator to perform collision avoidance action (conjunctions). <br/> Screenings are not automatically submitted for processing upon creation, unless the submit query parameter is used. Screenings can be further configured using the various /screenings/{id} endpoints and then submitted for processing using PUT /screenings/{id}/submit. <br/> Because Screenings are processed in a queue, screening is an asynchronous operation. The status and results of a submitted screening can be found by retrieving the Screening using GET /screenings/{id}.

post/screenings

Request

  • Base URL: https://api.satcat.com/api/satcat
  • URL: https://api.satcat.com/api/satcat/screenings
  • Auth: OAuth 2 (client credentials, token URL oauth/token; password, token URL login)

Query parameters

submitboolean

Whether to automatically submit the screening for processing upon creation. If not used, the screening can be further configured and later submitted using the screening actions subresources.

group_idstring uuid nullable

Optional group ID to use for the request

Request body

group_idstring uuid nullable
threshold_radius_kmnumber
threshold_radius_manned_kmnumber nullable
threshold_radius_active_kmnumber nullable
threshold_radius_debris_kmnumber nullable
default_secondary_hbr_mnumber
auto_archiveboolean
include_primary_vs_primaryboolean
titlestring nullable
notesstring nullable
screening_type'ON_ORBIT' | 'LAUNCH'
engine'automatic' | 'classic' | 'caskd'
launch_window_startstring date-time nullable
launch_window_endstring date-time nullable
launch_window_cadence_sinteger nullable
hard_body_shape'SQUARE' | 'CIRCLE'
strict_coverageboolean
publish_cdmsboolean nullable
allow_synthetic_covarianceboolean nullable
schedule_idstring uuid nullable

Response

Successful Response

idstring uuid required
titlestring required
notesstring nullable
engine'automatic' | 'classic' | 'caskd' required
engine_used'automatic' | 'classic' | 'caskd'
secondary_any_coverage_endstring date-time nullable
secondary_any_coverage_startstring date-time nullable
secondary_full_coverage_endstring date-time nullable
secondary_full_coverage_startstring date-time nullable

Changes

  • 9a3b0a312528Revision changes
    • info

      added the new optional request property

  • fba1aea33824Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status