Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API endpoints

SS01 | Store search

POST

/savedsearches

User permission required

Supported Content Type(s)

    JSON
  • application/json

Remarks

  • The JSON properties title, type and queryString must exist.
  • The queryString must be encoded with Base64.

...

Supported Content Type(s)

    JSON
  • application/json

Remarks

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

...

Supported Content Type(s)

    JSON
  • application/json

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.
  • The queryString must be encoded with Base64.

...

Supported Content Type(s)

    JSON
  • application/json

Status codes

  • 204 = Search updated
  • 400 = Wrong usage of endpoint
  • 401 = User is not authorized
  • 403 = Forbidden (User is not owner of Search)
  • 404 = Search ID not found
  • 500 = Internal server error

...

DELETE

/savedsearches/{id}

User permission required

Supported Content Type(s)

  • application/json

Status codes

  • 204 = Search deleted (No content)
  • 400 = Wrong usage of endpoint
  • 401 = User is not authorized
  • 403 = Forbidden (User is not owner of Search)
  • 404 = Search ID not found
  • 500 = Internal server error

...