This API endpoint gives access to various functions of the sat-nms satoperator 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/satoperators
Returns the list of stored satoperators as an array of SatDbSatOperator data objects.
Parameters: none
Expected Payload: none
Replied Payload: The list of stored satoperators as an array of SatDbSatOperator data objects.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a JSON document with all satoperators and their attributes. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
GET /api/v1/satoperators/{operatorId}
Returns the basic properties of the satoperator addressed by {operatorId} as a SatDbSatOperator data object.
Parameters:
| Parameter | Description |
|---|---|
| operatorId | Id of the satoperator. |
Expected Payload: none
Replied Payload: The requested SatDbSatOperator data object.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a document describing the requested satoperator. |
| 401 | not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | satoperator with the given operatorId does not exists. In this case an ApiError document is returned, describing details of the error. |
POST /api/v1/satoperators
Creates a new satoperator with the given attributes. The unique operatorId is generated by the database backend and returned in the response document.
Parameters: none
Expected Payload: The SatDbSatOperator data object to store. Any operatorId 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 SatDbSatOperator data object added to the datbase. The replied data object contains the operatorId assigned to the newly created record.
Return Codes:
| Code | Description |
|---|---|
| 201 | CREATED, the created SatDbSatOperator data object is replied as payload |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
PATCH /api/v1/satoperators/{operatorId}
Updates an existing satellite operator with the given operatorId from the attached SatDbSatOperator data object.
Parameters:
| Parameter | Description |
|---|---|
| operatorId | Id of the satoperator. |
Expected Payload: The SatDbSatOperator data object containing the fields to be updated in the database. If the data object contains an operatorId key, the value is ignored. The database record is solely identified by operatorId set in the URL, the operatorId of the record is immutable. Keys not contained in the supplied data object are retained unchanged.
Replied Payload: The SatDbSatOperator data object read from the datbase after the requested changes have been applied.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, changes have been applied. |
| 401 | not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | the satellite operator with the given operatorId does not exists. In this case an ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
DELETE /api/v1/satoperators/{operatorId}
Remove a satoperator from the database. This deletes the satoperator's record from the satoperator table and removes all references to the deleted satoperator in the satellites table.
Parameters:
| Parameter | Description |
|---|---|
| operatorId | Id of the satoperator to delete |
Expected Payload: none
Replied Payload: none
Return Codes:
| Code | Description |
|---|---|
| 204 | NO CONTENT, the satellite has been deleted. |
| 401 | not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | the satellite operator with the given operatorId does not exists. In this case an ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |