POST
https://ushahididocs.api.ushahidi.io/api/v3/layers
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
{
"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"
]
}
PUT
https://ushahididocs.api.ushahidi.io/api/v3/layers/1
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
{
"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"
]
}
Sorting parameter Available values : entity fields Default value : id
id
Sorting parameter Available values : [ASC,DESC] Default value : ASC
asc
Paging parameter Default value : null
2
Paging parameter Default value : 0
3
Filter Parameter check the type
true
Filter Parameter check the type Available values : [wms,geojson]
geojson
GET /api/v3/layers HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"results": [
{
"id": 1,
"url": "text",
"name": "text",
"data_url": "text",
"media": "text",
"type": "text",
"options": {
"layers": "text",
"format": "text",
"transparent": true
},
"active": true,
"visible_by_default": true,
"created": "text",
"updated": "text",
"allowed_privileges": [
"text"
]
}
],
"limit": "text",
"offset": 1,
"order": "text",
"orderby": "text",
"curr": "text",
"next": "text",
"prev": "text",
"total_count": 1
}
GET /api/v3/layers/1 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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 /api/v3/layers/5 HTTP/1.1
Host: ushahididocs.api.ushahidi.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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"
]
}