FOR ARCHIVAL PURPOSES ONLY

The information in this wiki hasn't been maintained for a good while. Some of the projects described have since been deprecated.

In particular, the "Ushahidi Platform v3.x" section contains information that is often misleading. Many details about this version of Platform have changed since.

This website is an extraction of the original Ushahidi wiki into a static form. Because of that, functions like logging in, commenting or searching will not work.

For more documentation, please refer to https://docs.ushahidi.com

Skip to end of metadata
Go to start of metadata

Posts GeoJSON Api returns Posts in GeoJSON format. The API accepts the same params as the standard Posts API, but is read-only and only accepts GET requests.


GET posts

Listing all posts

METHOD: GET
ENDPOINT: /api/v2/posts/geojson
AUTHENTICATED: No

Query Parameters

Name

Type

Description

q

Optional

Only Posts containing this search string will be returned, matched against post title and content

type

Optional

Only posts of this type will be returned: report, revision, comment or alert

localeOptionalOnly posts with matching locale will be returned

slug

Optional

Only posts with a matching slug will be returned

form_id

Optional

Only posts with this form_id will be returned

user_id

Optional

Only posts created by this user_id will be returned

created_before

Optional

Returned posts will have a created date smaller than this date

created_after

Optional

Returned posts will have a created date greater than this date

updated_before

Optional

Returned posts will have an updated date smaller than this date

updated_after

Optional

Returned posts will have an updated date greater than this date

bboxOptionalReturned posts will have a point attribute within the specified bounding box. bbox expects lat lon values as follows: west,north,east,south
geometry_attributeOptionalReturned GeoJSON will only include geometries for the specified attribute

order

Optional

Returned posts will be sorted in this order: ASC or DESC. Default: DESC

order_by

Optional

Returned posts will be sorted by this field. Default: created

limit

Optional

Limit number of results returned. Default: 50. Max: 500

offset

Optional

Posts returned will be offset by this number of results

Example Request

GET https://ushv3.dev/api/v2/posts/geojson

Response

Bounding Box Search Example

GET https://ushv3.dev/api/v2/posts/geojson?bbox=-2,-2,2,2

Response

Specific 'geometry_attribute' Example

GET https://ushv3.dev/api/v2/posts/geojson?geometry_attribute=second_point

Response

GET posts/:id

Get a single post

METHOD: GET
ENDPOINT: /api/v2/posts/:id/geojson
AUTHENTICATED: Yes

Query Parameters

Name

Type

Description

id

Required

The numerical id of the post being retrieved.

Example Request

GET http://ushv3.dev/api/v2/posts/1/geojson

Response

GET posts/geojson/:z/:x/:y

Get tiled geojson response

METHOD: GET
ENDPOINT: /api/v2/posts/geojson/:z/:x/:y
AUTHENTICATED: No

Query Parameters

Name

Type

Description

zRequiredZoom level
xRequiredTile x offset
yRequiredTile y offset

q

Optional

Only Posts containing this search string will be returned, matched against post title and content

type

Optional

Only posts of this type will be returned: report, revision, comment or alert

localeOptionalOnly posts with matching locale will be returned

slug

Optional

Only posts with a matching slug will be returned

form_id

Optional

Only posts with this form_id will be returned

user_id

Optional

Only posts created by this user_id will be returned

created_before

Optional

Returned posts will have a created date smaller than this date

created_after

Optional

Returned posts will have a created date greater than this date

updated_before

Optional

Returned posts will have an updated date smaller than this date

updated_after

Optional

Returned posts will have an updated date greater than this date

bboxOptionalReturned posts will have a point attribute within the specified bounding box. bbox expects lat lon values as follows: west,north,east,south
geometry_attributeOptionalReturned GeoJSON will only include geometries for the specified attribute

order

Optional

Returned posts will be sorted in this order: ASC or DESC. Default: DESC

order_by

Optional

Returned posts will be sorted by this field. Default: created

limit

Optional

Limit number of results returned. Default: 50. Max: 500

offset

Optional

Posts returned will be offset by this number of results

Example Request

GET https://ushv3.dev/api/v2/posts/geojson/1/1/0

Response
  • No labels