Saved Search

get saved search by ID

GEThttps://ushahididocs.api.ushahidi.io/api/v3/savedsearches/4

Response

200404

OK

Body

application/json

idinteger (int32)

urlnullable string

filtergetsavedsearches_filter (object)

Example: "{\"q\":\"test\"}"

user_idnullable string

namestring

descriptionstring

viewstring

view_optionsnullable string

rolenullable string

featuredboolean

createdstring

updatednullable string

allowed_privilegesarray of string

Request

JavaScriptCurl

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/savedsearches/4', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 4,
  "filter": {
    "q": "test"
  },
  "name": "Test search",
  "description": "",
  "view": "list",
  "featured": false,
  "created": "1970-01-01T00:00:00+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ],
  "__$markdownParsed": true
}

add saved search

POST https://ushahididocs.api.ushahidi.io/api/v3/savedsearches

Request Body

Name	Type	Description
filter	Object	The flter keyword
role	String	Roles
view	String	View type for saved search
description	String	Search description
name	String	name of search
user_id	String	The user identifier
view_options	String	View options
featured	Boolean	Set True for featured and false for not featured

200: OK

{
    "id": 10,
    "url": null,
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "filter": {
        "q": "test"
    },
    "name": "Test search",
    "description": "",
    "view": "list",
    "view_options": null,
    "role": null,
    "featured": false,
    "created": "2022-11-01T07:13:17+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

edit saved search by ID

PUT https://ushahididocs.api.ushahidi.io/api/v3/savedsearches/4

Request Body

Name	Type	Description
filter	Object	The flter keyword
role	String	Roles
view	String	View type for saved search
description	String	Search description
name	String	name of search
user_id	String	The user identifier
view_options	String	View options
featured	Boolean	Set True for featured and false for not featured

200: OK

{
    "id": 10,
    "url": null,
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "filter": {
        "q": "test"
    },
    "name": "Test search",
    "description": "",
    "view": "list",
    "view_options": null,
    "role": null,
    "featured": false,
    "created": "2022-11-01T07:13:17+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

delete saved search by ID

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/savedsearches/8

Response

200401404

OK

Body

application/json

id*integer (int32)

url*nullable string

user*createsavedsearch_user (object)

Example: "{\"id\":1,\"url\":\"http://localhost:8000/api/v3/users/1\"}"

filter*getsavedsearches_filter (object)

Example: "{\"q\":\"test\"}"

name*string

description*string

view*string

view_options*nullable string

role*nullable string

featured*boolean

created*string

updated*nullable string

allowed_privileges*array of string

Request

JavaScriptCurl

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/savedsearches/8', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 9,
  "user": {
    "id": 2,
    "url": "http://localhost:8000/api/v3/users/2"
  },
  "filter": {
    "q": "test"
  },
  "name": "Test search",
  "description": "",
  "view": "list",
  "featured": false,
  "created": "2022-10-12T19:01:13+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ],
  "__$markdownParsed": true
}