API endpoints
SS01 | Store search
POST | /savedsearches |
|---|
User permission required
Remarks
- The JSON properties title and queryString must exist.
- The JSON properties type could be null or empty.
Request payload
Response payload
Status codes
- 200 = Search stored
- 400 = Title or queryString is missing (required)
- 401 = User is not authorized
- 500 = Internal server error
Example call(s)
- Store search
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches
SS02 | Retrieves searches
GET | /savedsearches |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| title | Title of search | Once | - | Optional |
| query | Base 64 coded search string | Once | - | Optional |
| type | Type of search like item, entity, institution or newspaper | Once | - | Optional |
Response payload
Status codes
- 200 = Bookmark(s) found
- 400 = Missing some search params
- 401 = User not authorized
- 500 = Internal server error
Example call(s)
- Retrieve searches by title
- ?
- Retrieve searches by search query
- ?
- Retrieve searches by type
- ?
SS03 | Update search
PUT | /savedsearches/{id} |
|---|
User permission required
Request payload
Response payload
Status codes
- 200 = Bookmark updated
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
Example call(s)
- Update search
- ?
SS04 | Delete search
DELETE | /savedsearches/{id} |
|---|
User permission required
Response payload
Status codes
- 200 = Bookmark deleted
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
Example call(s)
- Delete search
- ?