Collections

get_collections

GEThttps://ushahididocs.api.ushahidi.io/api/v3/collections

Query parameters

Response

200

OK

Body

application/json

count*integer (int32)

results*array of get_collections_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurl

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

Response

{
  "results": [
    {
      "url": "text",
      "user_id": "text",
      "name": "text",
      "description": "text",
      "view": "text",
      "view_options": "text",
      "role": [
        "text"
      ],
      "featured": false,
      "created": "text",
      "updated": "text",
      "allowed_privileges": [
        "text"
      ],
      "user": {
        "url": "text"
      }
    }
  ],
  "limit": "text",
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text"
}

add collection

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

Request Body

Name	Type	Description
user_id	String	The user identifier
view	String	Type of view e.g. "list"
description	String	Collection description
name	String	The name of collection
view_options	String	View Option
role	String	Role
featured	Boolean	Set True to feature collection and False for unfeatured

200: OK

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

edit collection

PUT https://ushahididocs.api.ushahidi.io/api/v3/collections/3

Request Body

Name	Type	Description
user_id	String	The user identifier
view	String	Type of view e.g. "list"
description	String	Collection description
name	String	The name of collection
view_options	String	View Option
role	String	Role
featured	Boolean	Set True to feature collection and False for unfeatured

200: OK

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

get collection

GEThttps://ushahididocs.api.ushahidi.io/api/v3/collections/1

Response

200404

OK

Body

application/json

id*integer (int32)

url*nullable string

user_id*nullable string

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/collections/1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

delete collection

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/collections/3

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\"}"

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/collections/3', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 11,
  "user": {
    "id": 2,
    "url": "http://localhost:8000/api/v3/users/2"
  },
  "name": "Test collection",
  "description": "",
  "view": "list",
  "featured": false,
  "created": "2022-11-01T08:13:25+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ],
  "__$markdownParsed": true
}