User Settings

get user settings

GEThttps://ushahididocs.api.ushahidi.io/api/v3/users/2/settings

Response

200

OK

Body

application/json

countinteger

resultarray of UserSettingsResponseList_result (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurl

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

Response

{
  "result": [
    {
      "url": "text",
      "user": [
        {
          "url": "text",
          "config_key": "text",
          "config_value": "text",
          "created": "text",
          "updated": "text",
          "allowed_privileges": [
            "text"
          ],
          "gravatar": "text"
        }
      ]
    }
  ],
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text"
}

add user settings

POST https://ushahididocs.api.ushahidi.io/api/v3/users/5/settings

Request Body

Name	Type	Description
config_key	String	The configuration key
config_value	String	The configuration value

200: OK

{
    "id": 1,
    "url": "http://localhost:8000/api/v3/user_settings/1",
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "config_key": "api some key222",
    "config_value": "******alue",
    "created": "2030-01-01T06:00:00+00:00",
    "updated": "2022-10-12T18:09:31+00:00",
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
    ]
}{
    "id": 1,
    "url": "http://localhost:8000/api/v3/user_settings/1",
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "config_key": "api some key222",
    "config_value": "******alue",
    "created": "2030-01-01T06:00:00+00:00",
    "updated": "2022-10-12T18:09:31+00:00",
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
    ]
}

edit user settings

PUT https://ushahididocs.api.ushahidi.io/api/v3/users/2/settings/6

Request Body

Name	Type	Description
config_key	String	The configuration key
config_value	String	The configuration value

200: OK

{
    "id": 1,
    "url": "http://localhost:8000/api/v3/user_settings/1",
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "config_key": "api some key222",
    "config_value": "******alue",
    "created": "2030-01-01T06:00:00+00:00",
    "updated": "2022-10-12T18:09:31+00:00",
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
    ]
}{
    "id": 1,
    "url": "http://localhost:8000/api/v3/user_settings/1",
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "config_key": "api some key222",
    "config_value": "******alue",
    "created": "2030-01-01T06:00:00+00:00",
    "updated": "2022-10-12T18:09:31+00:00",
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search",
        "read_full",
        "register"
    ]
}

delete user settings

DELETEhttps://ushahididocs.api.ushahidi.io/api/v3/users/1/settings/40

Response

200404

OK

Body

application/json

idinteger

urlstring

userarray of UserSettingsResponseList_user (object)

Request

JavaScriptCurl

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

Response

{
  "url": "text",
  "user": [
    {
      "url": "text",
      "config_key": "text",
      "config_value": "text",
      "created": "text",
      "updated": "text",
      "allowed_privileges": [
        "text"
      ],
      "gravatar": "text"
    }
  ]
}