8.2.30 /api/v1/antennas

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

Supported HTTP methods: GET, POST, PATCH, DELETE, HEAD, OPTIONS

The API generally does not permit PATCH or DELETE operations on entire tables, this to protect the database from being accidentally be deleted. Even POST operations only work with single data objects.

GET /api/v1/antennas

Returns the list of stored antennas as an array of SatDbAntenna data objects.

Parameters: none

Expected Payload: none

Replied Payload: The list of stored antennas as an array of SatDbAntenna data objects.

Return Codes:

GET /api/v1/antennas/{antennaId}

Returns the basic properties of the antenna addressed by {antennaId} as a SatDbAntenna data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbAntenna data object.

Return Codes:

POST /api/v1/antennas

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

Parameters: none

Expected Payload: The SatDbAntenna data object to store. Any antennaId 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 SatDbAntenna data object added to the database. The replied data object contains the antennaId assigned to the newly created record.

Return Codes:

PATCH /api/v1/antennas/{antennaId}

Updates an existing antenna with the given antennaId from the attached SatDbAntenna data object.

Parameters:

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

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

Return Codes:

DELETE /api/v1/antennas/{antennaId}

Remove a antenna from the database. This deletes the antenna's record from the antenna table and all records from the satpositions table which refer to the deleted antenna.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

GET /api/v1/antennas/{antennaId}/positions

Returns the list of satellite positions for a given antenna 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 satellite positions defined for this antenna.

Return Codes:

GET /api/v1/antennas/{antennaId}/positions/{positionId}

Returns the information stored for a particular satellite position addressed by {antennaId} / {positionId} as a SatDbPosition data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbPosition data object.

Return Codes:

ST /api/v1/antennas/{antennaId}/positions

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

Parameters:

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

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

Return Codes:

PATCH /api/v1/antennas/{antennaId}/positions/{positionId}

Updates an existing satellite position with the given antennaId / positionId from the attached SatDbPosition data object.

Parameters:

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

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

Return Codes:

DELETE /api/v1/antennas/{antennaId}/positions/{positionId}

Remove a satellite position from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/antennas/{antennaId}/positions

Remove all satellite positions which belong to the given antennaId.

Parameters:

Return Codes:

GET /api/v1/antennas/{antennaId}/ttracks

Returns the list of table track data sets for a given antenna as an array of SatDbTableTracking data objects.

Parameters:

Expected Payload: none

Replied Payload: The list of table track data sets as an array of SatDbTableTracking data objects. This array may be empty if there are no table track data sets defined for this antenna.

Return Codes:

GET /api/v1/antennas/{antennaId}/{satelliteId}/ttracks

Returns the list of table track data sets for a given satellite/antenna combination as an array of SatDbTableTracking data objects.

Parameters:

Expected Payload: none

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

Return Codes:

GET /api/v1/antennas/{antennaId}/{satelliteId}/ttracks/{ttId}

Returns the information stored for a particular table track data set addressed by {antennaId} / {satelliteId} / {ttId} as a SatDbTableTracking data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTableTracking data object.

Return Codes:

POST /api/v1/antennas/{antennaId}/{satelliteId}/ttracks

Creates a new table track data set with the given attributes. {antennaId} / {satelliteId} specifies the satellite / antenna combination for which the table track data set shall be created. The unique ttId is generated by the database backend and returned in the response document.

Parameters:

Expected Payload: The SatDbTableTracking data object to store. Any ttId 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 SatDbTableTracking 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 SatDbTableTracking data object added to the datbase. The replied data object contains the ttId assigned to the newly created record.

Return Codes:

PATCH /api/v1/antennas/{antennaId}/{satelliteId}/ttracks/{ttId}

Updates an existing table tracking data set with the given antennaId / satelliteId / ttId from the attached SatDbTableTracking data object.

Parameters:

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

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

Return Codes:

DELETE /api/v1/antennas/{antennaId}/{satelliteId}/ttracks/{ttId}

Remove a table track data set from the database.

Parameters:

Expected Payload: none

Replied Payload: none

Return Codes:

DELETE /api/v1/antennas/{antennaId}/{satelliteId}/ttracks

Remove all table track data sets which belong to the given satelliteId / antennaId combination.

Parameters:

Return Codes:

DELETE /api/v1/antennas/{antennaId}/ttracks

Remove all table track data sets which belong to the given antenna.

Parameters:

Return Codes:

GET /api/v1/antennas/{antennaId}/beacon-atten/{beaconId}

Returns the attenuation value addressed by {antennaId} / {beaconId} as a SatDbBeaconAttenuation data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbBeaconAttenuation data object. If no attenuation has been stored for this antennaId/beaconId combination, an empty SatDbBeaconAttenuation data object with the attenuation value set to 0.0 is returned.

Return Codes:

PUT /api/v1/antennas/{antennaId}/beacon-atten/{beaconId}

Sets the attenuation value for an {antennaId} / {beaconId} combination. Returns the attenuation set as a SatDbBeaconAttenuation data object. If no attenuation record exists for this antenna / beacon combination a new one is created. If there is already an attenuation record for this combination, the existing one will be overwritten.

Parameters:

Expected Payload: The attenuation to set as a SatDbBeaconAttenuation data object. Only the attenuation is read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbBeaconAttenuation data object with the updated attenuation .

Return Codes:

PATCH /api/v1/antennas/{antennaId}/beacon-atten/{beaconId}

Sets the attenuation value for an {antennaId} / {beaconId} combination. Returns the attenuation set as a SatDbBeaconAttenuation data object.

Parameters:

Expected Payload: The attenuation to set as a SatDbBeaconAttenuation data object. Only the attenuation is read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbBeaconAttenuation data object with the updated attenuation .

Return Codes:

DELETE /api/v1/antennas/{antennaId}/beacon-atten/{beaconId}

Deletes the attenuation value addressed by {antennaId} / {beaconId}.

Parameters:

Expected Payload: none

Replied Payload: none.

Return Codes:

GET /api/v1/antennas/{antennaId}/tc-atten/{tcId}

Returns the attenuation values addressed by {antennaId} / {tcId} as a SatDbTcAttenuation data object. If no attenuation has been stored for this antennaId/tcId combination, an empty SatDbTcAttenuation data object with the attenuation values set to 0.0 is returned.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTcAttenuation data object.

Return Codes:

PUT /api/v1/antennas/{antennaId}/tc-atten/{tcId}

Sets the attenuation values for an {antennaId} / {tcId} combination. Returns the attenuation set as a SatDbTcAttenuation data object. If no attenuation record exists for this antenna / tc combination a new one is created. If there is already an attenuation record for this combination, the existing one will be overwritten.

Parameters:

Expected Payload: The attenuation to set as a SatDbTcAttenuation data object. Only the attenuation values are read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbTcAttenuation data object with the updated attenuation .

Return Codes:

PATCH /api/v1/antennas/{antennaId}/tc-atten/{tcId}

Modifies the attenuation values for an {antennaId} / {tcId} combination. Returns the attenuation set as a SatDbTcAttenuation data object.

Parameters:

Expected Payload: One or both attenuation values to set in a SatDbTcAttenuation data object. Only the attenuation values are read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbTcAttenuation data object with the updated attenuation.

Return Codes:

DELETE /api/v1/antennas/{antennaId}/tc-atten/{tcId}

Deletes the attenuation values addressed by {antennaId} / {tcId}.

Parameters:

Expected Payload: none

Replied Payload: none.

Return Codes:

GET /api/v1/antennas/{antennaId}/tm-atten/{tmId}

Returns the attenuation values addressed by {antennaId} / {tmId} as a SatDbTmAttenuation data object.

Parameters:

Expected Payload: none

Replied Payload: The requested SatDbTmAttenuation data object. If no attenuation has been stored for this antennaId/tcId combination, an empty SatDbTmAttenuation data object with the attenuation values set to 0.0 is returned.

Return Codes:

PUT /api/v1/antennas/{antennaId}/tm-atten/{tmId}

Sets the attenuation values for an {antennaId} / {tmId} combination. Returns the attenuation values set as a SatDbTmAttenuation data object. If no attenuation record exists for this antenna / tm combination a new one is created. If there is already an attenuation record for this combination, the existing one will be overwritten.

Parameters:

Expected Payload: The attenuation to set as a SatDbTmAttenuation data object. Only the attenuation values are read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbTmAttenuation data object with the updated attenuation .

Return Codes:

PATCH /api/v1/antennas/{antennaId}/tm-atten/{tmId}

Modifies the attenuation values for an {antennaId} / {tmId} combination. Returns the attenuation set as a SatDbTmAttenuation data object.

Parameters:

Expected Payload: One or both attenuation values to set in a SatDbTmAttenuation data object. Only the attenuation values are read from this data object, any IDs passed to this API function are ignored. The IDs are defined solely by the URL parameters.

Replied Payload: The SatDbTmAttenuation data object with the updated attenuation.

Return Codes:

DELETE /api/v1/antennas/{antennaId}/tm-atten/{tmId}

Deletes the attenuation values addressed by {antennaId} / {tmId}.

Parameters:

Expected Payload: none

Replied Payload: none.

Return Codes: