Welcome!
The Orbital Refuse Collector (ORC) is a fictitious platform which provides an API offering resources to retrieve information about satellites and schedule their decommission.
See below for descriptions of callable endpoints.
If you’d like to learn more about the author, check out https://jamestasse.tech.
API Documentation
- GET /satellites
Get a list of satellites
Returns a list of all satellites
- Query Parameters:
satellitesToRetrieve (integer) – Number of satellites to retrieve (Required)
- Status Codes:
200 OK – A list of satellites
400 Bad Request – Failed to retrieve satellite list
500 Internal Server Error – Failed to retrieve satellite list
- PUT /satellites
Update a satellite
Update a satellite with the specified ID
- Status Codes:
200 OK – Satellite information updated successfully
400 Bad Request – Failed to update satellite information
500 Internal Server Error – Failed to update satellite information
- GET /satellites/{id}
Get a satellite by ID
Get a satellite with the specified ID
- Parameters:
id (integer) – Satellite ID
- Status Codes:
200 OK – Satellite information retrieved successfully
400 Bad Request – Failed to get satellite information
404 Not Found – Specified satellite not found
500 Internal Server Error – Failed to get satellite information
- DELETE /satellites/{id}
Delete a satellite
Delete a satellite with the specified ID
- Parameters:
id (integer) – Satellite ID
- Status Codes:
200 OK – Satellite deleted successfully
400 Bad Request – Failed to delete satellite
404 Not Found – Specified satellite not found
500 Internal Server Error – Failed to delete satellite
- POST /satellites/scheduleDecommission
Schedule decommission for a satellite
Schedule a decommission for the satellite with the specified ID
- Status Codes:
200 OK – Satellite decommission scheduled successfully
400 Bad Request – A problem occurred while attempting to schedule the satellite decommission.
500 Internal Server Error – A problem occurred while attempting to schedule the satellite decommission.