8.2.26 /api/v1/satellites

This API endpoint gives access to various functions of the sat-nms satellite database, permitting to read, add, change or delete entries at the database

Supported HTTP methods: GET, POST, PATCH, DELETE, HEAD, OPTIONS GET /api/v1/satellites

Returns the list of stored satellites as an array of SatDbSatellite data objects.

Parameters: none

Expected Payload: none

Replied Payload: The list of stored satellites as an array of SatDbSatellite data objects.

Return Codes:

GET /api/v1/satellites/{satelliteId}

Returns the basic properties of the satellite addressed by {satelliteId} as a SatDbSatellite data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbSatellite data object.

Return Codes:

POST /api/v1/satellites

Creates a new satellite with the given attributes . The unique satelliteId is generated by the database backend and returned in the response document.

Parameters: none

Expected Payload: The SatDbSatellite data object to store. Any satelliteId definition in the source is ignored as this will be set by the database when the new entry is created. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbSatellite data object added to the database. The replied data object contains the satelliteId assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}

Updates an existing satellite with the given satelliteId from the attached SatDbSatellite data object.

Parameters:

Expected Payload: The SatDbSatellite data object containing the fields to be updated in the database. If the data object contains a satelliteId key, the value is ignored. The database record is solely identified by satelliteId set in the URL, the satelliteId of the record is immutable. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbSatellite data object read from the database after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}

Remove a satellite from the database. This deletes the satellite's record from the satellite table and all records from other tables like beacons, TLEs etc which unambiguously depend on the deleted satellite.

Parameters:

Expected Payload: none

Replied Payload: The SatDbSatellite data object which has been deleted.

Return Codes:

GET /api/v1/satellites/{satelliteId}/positions

Returns the list of satellite positions for a given satellite as an array of SatDbPosition data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of satellite positions as an array of SatDbPosition data objects. This array may be empty if there are no positions defined for this satellite.

Return Codes:

GET /api/v1/satellites/{satelliteId}/beacons

Returns the list of satellite beacons for a given satellite as an array of SatDbBeacon data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of satellite beacons as an array of SatDbBeacon data objects. This array may be empty if there are no beacons defined for this satellite.

Return Codes:

GET /api/v1/satellites/{satelliteId}/beacons/{beaconId}

Returns the information stored for a particular satellite beacon addressed by {satelliteId} / {beaconId} as a SatDbBeacon data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbBeacon data object.

Return Codes:

POST /api/v1/satellites/{satelliteId}/beacons

Creates a new satellite beacon with the given attributes. {satelliteId} specifies the satellite for which the beacon shall be created. The unique beaconId is generated by the database backend and returned in the response document.

Parameters:

Expected Payload: The SatDbBeacon data object to store. Any beaconId definition in the source is ignored as this will be set by the database when the new entry is created. The same applies to satellite_Id, the newly created SatDbBeacon data object will be linked to the satellite specified in the URL. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbBeacon data object added to the datbase. The replied data object contains the beaconId assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}/beacons/{beaconId}

Updates an existing satellite beacon with the given satelliteId / beaconId from the attached SatDbBeacon data object.

Parameters:

Expected Payload: The SatDbBeacon data object containing the fields to be updated in the database. If the data object contains values for beaconId and / or satelliteId, these values are ignored. beaconId and satelliteId are immutable once a record has been created. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbBeacon data object read from the datbase after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/beacons/{beaconId}

Remove a satellite beacon from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/beacons

Remove all satellite beacons which belong to the given satelliteId.

Parameters:

Return Codes:

GET /api/v1/satellites/{satelliteId}/tcchans

Returns the list of satellite TC channels for a given satellite as an array of SatDbTc data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of satellite TC channels as an array of SatDbTc data objects. This array may be empty if there are no TC channels defined for this satellite.

Return Codes:

GET /api/v1/satellites/{satelliteId}/tcchans/{tcId}

Returns the information stored for a particular satellite TC channel addressed by {satelliteId} / {tcId} as a SatDbTc data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTc data object.

Return Codes:

POST /api/v1/satellites/{satelliteId}/tcchans

Creates a new satellite TC channel with the given attributes. {satelliteId} specifies the satellite for which the TC channel shall be created. The unique tcId is generated by the database backend and returned in the response document.

Parameters:

Expected Payload: The SatDbTc data object to store. Any tcId definition in the source is ignored as this will be set by the database when the new entry is created. The same applies to satelliteId, the newly created SatDbTc data object will be linked to the satellite specified in the URL. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbTc data object added to the datbase. The replied data object contains the tcId assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}/tcchans/{tcId}

Updates an existing satellite TC channel with the given satelliteId / tcId from the attached SatDbTc data object.

Parameters:

Expected Payload: The SatDbTc data object containing the fields to be updated in the database. If the data object contains values for tcId and / or satelliteId, these values are ignored. tcId and satelliteId are immutable once a record has been created. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbTc data object read from the datbase after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tcchans/{tcId}

Remove a satellite TC channel from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tcchans

Remove all satellite TC channels which belong to the given satelliteId.

Parameters:

Return Codes:

GET /api/v1/satellites/{satelliteId}/tmchans

Returns the list of satellite TM channels for a given satellite as an array of SatDbTm data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of satellite TM channels as an array of SatDbTm data objects. This array may be empty if there are no tm channels defined for this satellite.

Return Codes:

GET /api/v1/satellites/{satelliteId}/tmchans/{tmId}

Returns the information stored for a particular satellite TM channel addressed by {satelliteId} / {tmId} as a SatDbTm data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTm data object.

Return Codes:

POST /api/v1/satellites/{satelliteId}/tmchans

Creates a new satellite TM channel with the given attributes. {satelliteId} specifies the satellite for which the tm channel shall be created. The unique tmId is generated by the database backend and returned in the response document.

Parameters:

Expected Payload: The SatDbTm data object to store. Any tmId definition in the source is ignored as this will be set by the database when the new entry is created. The same applies to satelliteId, the newly created SatDbTm data object will be linked to the satellite specified in the URL. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbTm data object added to the datbase. The replied data object contains the tmId assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}/tmchans/{tmId}

Updates an existing satellite TM channel with the given satelliteId / tmId from the attached SatDbTm data object.

Parameters:

Expected Payload: The SatDbTm data object containing the fields to be updated in the database. If the data object contains values for tmId and / or satelliteId, these values are ignored. tmId and satelliteId are immutable once a record has been created. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbTm data object read from the datbase after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tmchans/{tmId}

Remove a satellite TM channel from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tmchans

Remove all satellite TM channels which belong to the given satelliteId.

Parameters:

Return Codes:

GET /api/v1/satellites/{satelliteId}/i11params

Returns the list of I11 parameter sets for a given satellite as an array of SatDbI11Data data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of I11 parameter sets as an array of SatDbI11Data data objects. This array may be empty if there are no I11 parameter sets defined for this satellite.

Return Codes:

GET /api/v1/satellites/{satelliteId}/i11params/{i11Id}

Returns the information stored for a particular I11 parameter set addressed by {satelliteId} / {i11Id} as a SatDbI11Data data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbI11Data data object.

Return Codes:

POST /api/v1/satellites/{satelliteId}/i11params

Creates a new I11 parameter set with the given attributes. {satelliteId} specifies the satellite for which the I11 parameter set shall be created. The unique i11Id is generated by the database backend and returned in the response document.

Parameters:

Expected Payload: The SatDbI11Data data object to store. Any i11Id definition in the source is ignored as this will be set by the database when the new entry is created. The same applies to satellite_Id, the newly created SatDbI11Data data object will be linked to the satellite specified in the URL. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbI11Data data object added to the datbase. The replied data object contains the i11Id assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}/i11params/{i11Id}

Updates an existing I11 parameter set with the given satelliteId / i11Id from the attached SatDbI11Data data object.

Parameters:

Expected Payload: The SatDbI11Data data object containing the fields to be updated in the database. If the data object contains values for i11Id and / or satelliteId, these values are ignored. i11Id and satelliteId are immutable once a record has been created. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbI11Data data object read from the datbase after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/i11params/{i11Id}

Remove a I11 parameter set from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/i11params

Remove all I11 parameter sets which belong to the given satelliteId.

Parameters:

Return Codes:

GET /api/v1/satellites/{satelliteId}/tleparams

Returns the list of TLE parameter sets for a given satellite as an array of SatDbTLEData data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of TLE parameter sets as an array of SatDbTLEData data objects. This array may be empty if there are no TLE parameter sets defined for this satellite. As there may be actually only one TLE parameter set for each satellite, the array may contain only zero or one elements.

Return Codes:

GET /api/v1/satellites/{satelliteId}/tleparams/{noradNumber}

Returns the information stored for a particular TLE parameter set addressed by {satelliteId} / {noradNumber} as a SatDbTLEData data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTLEData data object.

Return Codes:

POST /api/v1/satellites/{satelliteId}/tleparams

Creates a new TLE parameter set with the given attributes. {satelliteId} specifies the satellite for which the TLE parameter set shall be created. The unique noradNumber is taken from the noradNumber field in the satellite's master data and returned in the response document. Hence it is important that the noradNumber field in the satellite's master data has been set before to the correct value.

As there may be only TLE parameter set assigned to a satellite, this POST method behaves in a special way: If there already exists a TLE parameter set for this satellite, it will be silently overwritten by the POST call. The call proceeds, stores the new data and returns a 201 return code. This behavior ensures, that not more than one TLE parameter set can be assigned to a satellite.

Parameters:

Expected Payload: The SatDbTLEData data object to store. Any noradNumber definition in the source is ignored as this will be taken from the noradNumber field in the satellite's master data when the new entry is created. The same applies to satellite_Id, the newly created SatDbTLEData data object will be linked to the satellite specified in the URL. If other keys of the data object are missing, default values will be assigned these keys.

Replied Payload: The SatDbTLEData data object added to the datbase. The replied data object contains the noradNumber assigned to the newly created record.

Return Codes:

PATCH /api/v1/satellites/{satelliteId}/tleparams/{noradNumber}

Updates an existing TLE parameter set with the given satelliteId / noradNumber from the attached SatDbTLEData data object.

Parameters:

Expected Payload: The SatDbTLEData data object containing the fields to be updated in the database. If the data object contains values for noradNumber and / or satelliteId, these values are ignored. noradNumber and satelliteId are immutable once a record has been created. Keys not contained in the supplied data object are retained unchanged.

Replied Payload: The SatDbTLEData data object read from the datbase after the requested changes have been applied.

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tleparams/{noradNumber}

Remove a TLE parameter set from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/tleparams

Remove all TLE parameter sets which belong to the given satelliteId.

Parameters:

Return Codes:

DELETE /api/v1/satellites/{satelliteId}/ttracks

In general, the table track ('ttrack') API calls are located at /api/v1/antennas. The only call located at /api/v1/satellites is to temove all table track data sets which belong to the given satelliteId (for all antennas).

Parameters:

Return Codes: