...

API endpoints

SS01 | Store search

/savedsearches

User permission required

...

• Store search
  • POST https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches

^ Back to top

...

SS02 | Retrieves searches

/savedsearches

User permission required

Remarks

• If no query params are set, then it returns all searches of user

Query parameters

...

[
    {
        "id": 1,
        "userId": "fachstelle_museum",
        "title": "Goethe 1",
        "type": "newspaper",
        "queryString": "aHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv",
        "createdAt": "2025-04-18T10:56:08.916+00:00"
    },{
        "id": 2,
        "userId": "fachstelle_museum",
        "title": "Goethe 2",
        "type": "newspaper",
        "queryString": "bHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv",
        "createdAt": "2025-04-18T10:57:08.916+00:00"
    } 
]

Status codes

• 200 = Search(es) found400 = Missing some search params
• 401 = User not authorized
• 404 = No results
• 500 = Internal server error

Example call(s)

• Retrieve all searches for user
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456
• Retrieve searches by title
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456?title=Goethe 1
• Retrieve searches by queryString
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456?queryString=aHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv
• Retrieve searches by type
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456?type=newspaper
• Retrieve searches by type, queryString and type
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456?title=Goethe 1&type=newspaper&queryString=aHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv

^ Back to top

...

SS03 | Update search

/savedsearches/{id}

User permission required

Remarks

• Only JSON properties title, type and queryString could be updated.
• If JSON properties are null or not present, they are not updated and existing values are kept.
  Example: If you only set title, only the title property is updated.

...

• Update search
  • PUT https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456

^ Back to top

...

SS04 | Delete search

/savedsearches/{id}

User permission required

...

• Delete search
  • DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456

^ Back to top

...