POST posts
Create a Post
METHOD: POST
ENDPOINT: /api/v2/posts/
AUTHENTICATED: No
The request body is a JSON representation of the Ushahidi 3.x API Posts Resource being created.
Example request
POST https://ushv3.dev/api/v2/posts
GET posts
Listing all posts
METHOD: GET
ENDPOINT: /api/v2/posts/
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 |
| locale | Optional | Only 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 |
| bbox | Optional | Returned posts will have a point attribute within the specified bounding box. bbox expects lat lon values as follows: west,north,east,south |
| tags | Optional | Filter posts by one or more tags. Accepts a comma separated list of tag id's. By default we will return posts matching any of the tag ids. You can also use tags[all] or tags[any] to specify if posts should match all/any of the tag ids. |
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 |
Posts can also be filtered by form attributes by using the attribute as a parameter. ie
Example Request
GET https://ushv3.dev/api/v2/posts
Search Example
GET https://ushv3.dev/api/v2/posts?q=David
GET posts/:id
Get a single post
METHOD: GET
ENDPOINT: /api/v2/posts/:id
AUTHENTICATED: Yes
Query Parameters
Name | Type | Description |
|---|---|---|
id | Required | The numerical id of the post being updated. |
Example Request
GET http://ushv3.dev/api/v2/posts/1
PUT posts/:id
Update a post
METHOD: PUT
ENDPOINT: /api/v2/posts/:id
AUTHENTICATED: Yes
Query Parameters
Name | Type | Description |
|---|---|---|
id | Required | The numerical id of the post being updated. |
Example Request
PUT http://ushv3.dev/api/v2/posts/1
TODO
- Document deleting an attribute value
DELETE posts/:id
Deleting a post
METHOD: DELETE
ENDPOINT: /api/v2/posts/:id
AUTHENTICATED: YES
Query Parameters
Name | Type | Description |
|---|---|---|
id | Required | The numerical id of the post being deleted. |
Example request
DELETE /api/v2/posts/2