Categories

Get categories

GEThttps://ushahididocs.api.ushahidi.io/api/v5/categories

Query parameters

Response

200

OK

Body

application/json

results*array of getcategories_results (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "results": [
    {
      "parent_id": "text",
      "tag": "text",
      "slug": "text",
      "type": "text",
      "color": "text",
      "icon": "text",
      "description": "text",
      "role": [
        "text"
      ],
      "children": [
        {
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "description": "text",
          "role": "text",
          "children": [
            "text"
          ],
          "parent": {
            "parent_id": "text",
            "tag": "text",
            "slug": "text",
            "type": "text",
            "color": "text",
            "icon": "text",
            "description": "text",
            "role": "text",
            "parent": "text",
            "translations": {
              "es": {
                "tag": "text"
              }
            }
          },
          "enabled_languages": {
            "default": "text",
            "available": [
              "text"
            ]
          },
          "translations": {
            "es": {
              "tag": "text"
            },
            "enabled_languages": {
              "es": {
                "tag": "text"
              }
            }
          }
        }
      ],
      "parent": {
        "parent_id": "text",
        "tag": "text",
        "slug": "text",
        "type": "text",
        "color": "text",
        "icon": "text",
        "description": "text",
        "role": "text",
        "parent": "text",
        "translations": [
          "text"
        ],
        "enabled_languages": {
          "default": "text",
          "available": [
            "text"
          ]
        }
      },
      "translations": {
        "es": {
          "tag": "text"
        }
      },
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      }
    }
  ]
}

Add a category

POSThttps://ushahididocs.api.ushahidi.io/api/v5/categories

Body

application/json

base_languagestring

typestring

iconstring

colorstring

parent_idinteger (int32)

parent_id_originalnullable string

translationsobject

tagstring

slugstring

any

Response

201422

Created

Body

application/json

results*array of getcategories_results (object)

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "base_language": "22",
      "type": "category",
      "icon": "tag",
      "color": "",
      "parent_id": 5,
      "translations": {},
      "tag": "test243",
      "slug": "test243"
    }),
});
const data = await response.json();

Response

201422

{
  "results": [
    {
      "parent_id": "text",
      "tag": "text",
      "slug": "text",
      "type": "text",
      "color": "text",
      "icon": "text",
      "description": "text",
      "role": [
        "text"
      ],
      "children": [
        {
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "description": "text",
          "role": "text",
          "children": [
            "text"
          ],
          "parent": {
            "parent_id": "text",
            "tag": "text",
            "slug": "text",
            "type": "text",
            "color": "text",
            "icon": "text",
            "description": "text",
            "role": "text",
            "parent": "text",
            "translations": {
              "es": {
                "tag": "text"
              }
            }
          },
          "enabled_languages": {
            "default": "text",
            "available": [
              "text"
            ]
          },
          "translations": {
            "es": {
              "tag": "text"
            },
            "enabled_languages": {
              "es": {
                "tag": "text"
              }
            }
          }
        }
      ],
      "parent": {
        "parent_id": "text",
        "tag": "text",
        "slug": "text",
        "type": "text",
        "color": "text",
        "icon": "text",
        "description": "text",
        "role": "text",
        "parent": "text",
        "translations": [
          "text"
        ],
        "enabled_languages": {
          "default": "text",
          "available": [
            "text"
          ]
        }
      },
      "translations": {
        "es": {
          "tag": "text"
        }
      },
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      }
    }
  ]
}

Get one category

GEThttps://ushahididocs.api.ushahidi.io/api/v5/categories/100

Response

200404

OK

Body

application/json

results*array of getcategories_results (object)

Request

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "parent_id": "text",
      "tag": "text",
      "slug": "text",
      "type": "text",
      "color": "text",
      "icon": "text",
      "description": "text",
      "role": [
        "text"
      ],
      "children": [
        {
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "description": "text",
          "role": "text",
          "children": [
            "text"
          ],
          "parent": {
            "parent_id": "text",
            "tag": "text",
            "slug": "text",
            "type": "text",
            "color": "text",
            "icon": "text",
            "description": "text",
            "role": "text",
            "parent": "text",
            "translations": {
              "es": {
                "tag": "text"
              }
            }
          },
          "enabled_languages": {
            "default": "text",
            "available": [
              "text"
            ]
          },
          "translations": {
            "es": {
              "tag": "text"
            },
            "enabled_languages": {
              "es": {
                "tag": "text"
              }
            }
          }
        }
      ],
      "parent": {
        "parent_id": "text",
        "tag": "text",
        "slug": "text",
        "type": "text",
        "color": "text",
        "icon": "text",
        "description": "text",
        "role": "text",
        "parent": "text",
        "translations": [
          "text"
        ],
        "enabled_languages": {
          "default": "text",
          "available": [
            "text"
          ]
        }
      },
      "translations": {
        "es": {
          "tag": "text"
        }
      },
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      }
    }
  ]
}

Edit category

PUThttps://ushahididocs.api.ushahidi.io/api/v5/categories/70

Body

application/json

statusinteger

messagestring

any

Response

200404422

OK

Body

application/json

results*array of getcategories_results (object)

Request

JavaScriptCurlPython

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/categories/70', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "base_language": "22",
      "type": "category",
      "icon": "tag",
      "color": "",
      "parent_id": 5,
      "translations": {},
      "tag": "test2458",
      "slug": "test2436"
    }),
});
const data = await response.json();

Response

200404422

{
  "results": [
    {
      "parent_id": "text",
      "tag": "text",
      "slug": "text",
      "type": "text",
      "color": "text",
      "icon": "text",
      "description": "text",
      "role": [
        "text"
      ],
      "children": [
        {
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "description": "text",
          "role": "text",
          "children": [
            "text"
          ],
          "parent": {
            "parent_id": "text",
            "tag": "text",
            "slug": "text",
            "type": "text",
            "color": "text",
            "icon": "text",
            "description": "text",
            "role": "text",
            "parent": "text",
            "translations": {
              "es": {
                "tag": "text"
              }
            }
          },
          "enabled_languages": {
            "default": "text",
            "available": [
              "text"
            ]
          },
          "translations": {
            "es": {
              "tag": "text"
            },
            "enabled_languages": {
              "es": {
                "tag": "text"
              }
            }
          }
        }
      ],
      "parent": {
        "parent_id": "text",
        "tag": "text",
        "slug": "text",
        "type": "text",
        "color": "text",
        "icon": "text",
        "description": "text",
        "role": "text",
        "parent": "text",
        "translations": [
          "text"
        ],
        "enabled_languages": {
          "default": "text",
          "available": [
            "text"
          ]
        }
      },
      "translations": {
        "es": {
          "tag": "text"
        }
      },
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      }
    }
  ]
}

Delete category

DELETEhttps://ushahididocs.api.ushahidi.io/api/v5/categories/6

Response

200404

OK

Body

application/json

resultDeletedResponse_result (object)

Request

JavaScriptCurlPython

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

Response

200404

{
  "result": {}
}