Form Role

get form roles

GEThttps://ushahididocs.api.ushahidi.io/api/v3/forms/2/roles

Query parameters

Response

200

OK

Body

application/json

count*integer (int32)

results*array of getformroles_results (object)

limit*nullable string

offset*integer (int32)

order*string

orderby*string

curr*string

next*string

prev*string

total_count*integer (int32)

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "url": "http://localhost:8000/forms/2/roles/1",
      "form_id": 2,
      "role_id": 1,
      "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
      ]
    }
  ],
  "offset": 0,
  "order": "asc",
  "orderby": "role_id",
  "curr": "http://localhost:8000/api/v3/forms/2/roles?orderby=role_id&order=asc&offset=0",
  "next": "http://localhost:8000/api/v3/forms/2/roles?orderby=role_id&order=asc&offset=0",
  "prev": "http://localhost:8000/api/v3/forms/2/roles?orderby=role_id&order=asc&offset=0",
  "total_count": 1
}

edit form roles

PUT https://ushahididocs.api.ushahidi.io/api/v3/forms/2/roles

Request Body

Name	Type	Description
form_id	String	The form ID
roles	Array	List of roles by ID

200: OK

{
    // Response
}