Configuration

get configuration

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

Response

200401

OK

Body

application/json

countsinteger

resultsarray of configResponseList_results (object)

limitinteger

offsetinteger

orderstring

orderbystring

currstring

nextstring

prevstring

total_countinteger

Request

JavaScriptCurlPython

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

Response

200401

{
  "counts": 0,
  "results": [
    {
      "id": "text",
      "url": "text",
      "views": {
        "data": false,
        "map": false,
        "list": false,
        "chart": false,
        "timeline": false,
        "activity": false,
        "plan": false
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}

Get map configuration

GEThttps://ushahididocs.api.ushahidi.io/api/v3/config/map

Response

200404

OK

Body

application/json

idstring

urlstring

clusteringboolean

cluster_radiusinteger

location_precisioninteger

default_viewconfigMapResponse_default_view (object)

allowed_privilegesarray of string

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "text",
  "url": "text",
  "clustering": false,
  "cluster_radius": 0,
  "location_precision": 0,
  "default_view": {
    "lat": 0,
    "lon": 0,
    "zoom": 0,
    "baselayer": "text",
    "fit_map_boundaries": false,
    "icon": "text",
    "color": "text"
  },
  "allowed_privileges": [
    "text"
  ]
}

Edit Configuration

PUT https://ushahididocs.api.ushahidi.io/api/v3/config/map

Request Body

Name	Type	Description
lat	Integer	Map latitude
default_view	Object	This object contains more data on the map view
location_precision	Integer	location precision
cluster_radius	Integer	The cluster radius
clustering	Boolean	True for clustering and false for not clustering
url	String	Configuration URL
id	String	Body Identifier for configuration. E.g. Map
fit_map_boundaries	Boolean	Set True to fit map boundaries and false not to fit boundaries
baselayer	String	View base area
zoom	integer	Map zoom
lon	Integer	Map longitude
color	String	view color
icon	String	map icon name
allowed_privileges	Objects	The configuration privilege

200: OK

{
    "id": "map",
    "url": "http://localhost:8000/api/v3/config/map",
    "clustering": false,
    "cluster_radius": 80,
    "location_precision": 2,
    "default_view": {
        "lat": -1.3048035,
        "lon": 36.8473969,
        "zoom": 3,
        "baselayer": "MapQuestAerial",
        "fit_map_boundaries": true,
        "icon": "map-marker",
        "color": "blue"
    },
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}