Tags

Get tags

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

Authorization

bearerAuth

Query parameters

Response

200

OK

Body

application/json

countinteger

resultsarray of object

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/tags', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "count": 2,
  "results": [
    {
      "id": 10,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/10",
      "parent": {
        "id": 9,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/9"
      },
      "tag": "Child 1",
      "slug": "child-one",
      "type": "category",
      "icon": "tag",
      "priority": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": [
        "admin"
      ],
      "children": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    },
    {
      "id": 11,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/11",
      "parent": {
        "id": 9,
        "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/9"
      },
      "tag": "Child 2",
      "slug": "child-two",
      "type": "category",
      "icon": "tag",
      "priority": 0,
      "created": "1970-01-01T00:00:00.000Z",
      "role": [
        "admin"
      ],
      "children": [],
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "id",
  "curr": "https://ushahididocs.api.ushahidi.io//api/v3/tags?orderby=id&order=asc&offset=0",
  "next": "https://ushahididocs.api.ushahidi.io//api/v3/tags?orderby=id&order=asc&offset=0",
  "prev": "https://ushahididocs.api.ushahidi.io//api/v3/tags?orderby=id&order=asc&offset=0",
  "total_count": 2
}

Add tag

POST ushahididocs.api.ushahidi.io/api/v3/tags

Request Body

Name	Type	Description
parent_id	integer	Parent identifier for Tag
icon	String	Tag icon name
description	String	Tag description
color	String	Tag color
type	String	Type of tag
tag	String	Tag name
role	Array	Tag role
priority	Integer	Tag priority value
children	Array	An array of other dependent children tag

200: OK

{
  "id": 0,
  "url": "string",
  "parent_id": "string",
  "tag": "string",
  "slug": "string",
  "type": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "priority": 0,
  "created": "string",
  "role": [
    "string"
  ],
  "children": [
    "string"
  ],
  "allowed_privileges": [
    "string"
  ]
}

Edit tag

PUT ushahididocs.api.ushahidi.io/api/v3/tags/2

Request Body

Name	Type	Description
parent_id	Integer	Parent identifier for Tag
icon	String	Tag icon name
description	String	Tag description
color	String	Tag color
type	String	Type of tag
tag	String	Tag name
role	Array	Tag role
priority	Integer	Tag priority value
children	Array	An array of other dependent children tag

200: OK

{
  "id": 0,
  "url": "string",
  "parent_id": "string",
  "tag": "string",
  "slug": "string",
  "type": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "priority": 0,
  "created": "string",
  "role": [
    "string"
  ],
  "children": [
    "string"
  ],
  "allowed_privileges": [
    "string"
  ]
}

Get tag

GEThttps://ushahididocs.api.ushahidi.io/api/v3/tags/5

Authorization

bearerAuth

Response

200404

OK

Body

application/json

idinteger

urlstring

parent_idstring

tagstring

slugstring

typestring

colorstring

iconstring

descriptionstring

priorityinteger

createdstring

rolearray of string

childrenarray of string

allowed_privilegesarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/tags/5', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200404

{
  "id": 1,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/1",
  "tag": "Test tag",
  "slug": "test-tag",
  "type": "category",
  "icon": "tag",
  "priority": 0,
  "created": "1970-01-01T00:00:00.000Z",
  "role": [
    "admin",
    "user"
  ],
  "children": [],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

Delete tag

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/tags/5

Authorization

bearerAuth

Response

200404

OK

Body

application/json

idinteger

urlstring

parent_idstring

tagstring

slugstring

typestring

colorstring

iconstring

descriptionstring

priorityinteger

createdstring

rolearray of string

childrenarray of string

allowed_privilegesarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v3/tags/5', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200404

{
  "id": 5,
  "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/5",
  "tag": "Todo",
  "slug": "todo",
  "type": "status",
  "icon": "tag",
  "priority": 0,
  "created": "1970-01-01T00:00:00.000Z",
  "children": [
    {
      "id": 7,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/7"
    },
    {
      "id": 23,
      "url": "https://ushahididocs.api.ushahidi.io//api/v3/tags/23"
    }
  ],
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}