Layer

get layers

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

Query parameters

Response

200401

OK

Body

application/json

count*integer (int32)

results*array of getlayers_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/layers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "count": 0,
  "results": [
    {
      "id": 0,
      "url": "text",
      "name": "text",
      "data_url": "text",
      "media": "text",
      "type": "text",
      "options": {
        "layers": "text",
        "format": "text",
        "transparent": false
      },
      "active": false,
      "visible_by_default": false,
      "created": "text",
      "updated": "text",
      "allowed_privileges": [
        "text"
      ]
    }
  ],
  "limit": "text",
  "offset": 0,
  "order": "text",
  "orderby": "text",
  "curr": "text",
  "next": "text",
  "prev": "text",
  "total_count": 0
}

add layer

POST https://ushahididocs.api.ushahidi.io/api/v3/layers

Request Body

Name	Type	Description
name	String	Layer name
visible_by_default	Boolean	Set True to make the layer visible by default and False to not
active	Boolean	Set True for active layer and False for Inactive layer
options	Array	Contains an array of layer options
type	String	Layer type
media	String	media
data_url	String	Data source URL

200: OK

{
    "id": 4,
    "url": "http://localhost:8000/api/v3/layer/4",
    "name": "test",
    "data_url": "http://services.nationalmap.gov/ArcGIS/services/NEXRAD_Weather/MapServer/WMSServer",
    "media": null,
    "type": "geojson",
    "options": null,
    "active": true,
    "visible_by_default": true,
    "created": "2022-11-02T19:20:43+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

edit layer

PUT https://ushahididocs.api.ushahidi.io/api/v3/layers/1

Request Body

Name	Type	Description
name	String	Layer name
visible_by_default	Boolean	Set True to make the layer visible by default and False to not
active	Boolean	Set True for active layer and False for Inactive layer
options	Array	Contains an array of layer options
type	String	Layer type
media	String	media
data_url	String	Data source URL

200: OK

{
    "id": 4,
    "url": "http://localhost:8000/api/v3/layer/4",
    "name": "test",
    "data_url": "http://services.nationalmap.gov/ArcGIS/services/NEXRAD_Weather/MapServer/WMSServer",
    "media": null,
    "type": "geojson",
    "options": null,
    "active": true,
    "visible_by_default": true,
    "created": "2022-11-02T19:20:43+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}

get layer

GEThttps://ushahididocs.api.ushahidi.io/api/v3/layers/1

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

name*string

data_url*string

media*nullable string

type*string

options*array of string

active*boolean

visible_by_default*boolean

created*string

updated*nullable string

allowed_privileges*array of string

Request

JavaScriptCurlPython

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

Response

200401404

{
  "id": 1,
  "url": "http://localhost:8000/api/v3/layer/1",
  "name": "test",
  "data_url": "/media/test.geojson",
  "type": "geojson",
  "options": [],
  "active": true,
  "visible_by_default": true,
  "created": "1970-01-01T00:00:00+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}

delete layer

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

Response

200401404

OK

Body

application/json

id*integer (int32)

url*string

name*string

data_url*string

media*nullable string

type*string

options*nullable string

active*boolean

visible_by_default*boolean

created*string

updated*nullable string

allowed_privileges*array of string

Request

JavaScriptCurlPython

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

Response

200401404

{
  "id": 5,
  "url": "http://localhost:8000/api/v3/layer/5",
  "name": "test",
  "data_url": "http://services.nationalmap.gov/ArcGIS/services/NEXRAD_Weather/MapServer/WMSServer",
  "type": "geojson",
  "active": true,
  "visible_by_default": true,
  "created": "2022-11-02T19:21:27+00:00",
  "allowed_privileges": [
    "read",
    "create",
    "update",
    "delete",
    "search"
  ]
}