mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-04 20:42:52 +00:00
12 KiB
12 KiB
Routes
POST / Index route
Route to request meta information about the deployment
Definition
| parameter | value |
|---|---|
| request | SCIndexRequest |
| response | SCIndexResponse |
| success code | 200 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
PUT /:TYPE/:UID Thing update route
Route for updating existing things
Definition
| parameter | value | ||||||
|---|---|---|---|---|---|---|---|
| request | SCThingUpdateRequest | ||||||
| response | SCThingUpdateResponse | ||||||
| success code | 200 | ||||||
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCNotFoundErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
||||||
| obligatory parameters |
|
POST /bookAvailability Book availability route
Route for book availability
This checks if a book is available in a library.
Example:
POST https://example.com/bookAvailability
{
"isbn": "978-3-16-148410-0"
}
Definition
| parameter | value |
|---|---|
| request | SCBookAvailabilityRequest |
| response | SCBookAvailabilityResponse |
| success code | 200 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCNotFoundErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
POST /bulk Bulk route
Route for bulk creation
Definition
| parameter | value |
|---|---|
| request | SCBulkRequest |
| response | SCBulkResponse |
| success code | 200 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
POST /bulk/:UID Bulk add route
Route for indexing SC things in a bulk
Definition
| parameter | value | ||||
|---|---|---|---|---|---|
| request | SCBulkAddRequest | ||||
| response | SCBulkAddResponse | ||||
| success code | 201 | ||||
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCNotFoundErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
||||
| obligatory parameters |
|
POST /bulk/:UID/done Bulk done route
Route for closing bulks
Definition
| parameter | value | ||||
|---|---|---|---|---|---|
| request | SCBulkDoneRequest | ||||
| response | SCBulkDoneResponse | ||||
| success code | 204 | ||||
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCNotFoundErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
||||
| obligatory parameters |
|
POST /feedback Feedback route
Route for feedback submission
Definition
| parameter | value |
|---|---|
| request | SCFeedbackRequest |
| response | SCFeedbackResponse |
| success code | 204 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
POST /search/multi Multi search route
Route for submission of multiple search requests at once
Definition
| parameter | value |
|---|---|
| request | SCMultiSearchRequest |
| response | SCMultiSearchResponse |
| success code | 200 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCTooManyRequestsErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |
POST /search Search route
Route for searching things
Definition
| parameter | value |
|---|---|
| request | SCSearchRequest |
| response | SCSearchResponse |
| success code | 200 |
| errors | SCInternalServerErrorResponse SCMethodNotAllowedErrorResponse SCUnsupportedMediaTypeErrorResponse SCValidationErrorResponse |