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

Versions Compared

Old Version 7

changes.mady.by.user Linda Kamau

Saved on

compared with

New Version Current

changes.mady.by.user Robbie Mackay

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add missing json examples

...

: report, revision, comment or alert

Name

Type

Description

q

Optional

Only sets containing this search string will be returned, matched against 'tagname' property

typename

Optional

Only sets of this type with a matching 'name' will be returned

user_idOptionalOnly sets with this user_id will be returned

order

Optional

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

order_by

Optional

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

limit

Optional

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

offset

Optional

Sets returned will be offset by this number of results

...

Anchor
put-id

PUT sets/:id

Update a [resource]a set

METHOD: PUT
ENDPOINT: /api/v2/sets/:id
AUTHENTICATED: Yes

...

Panel

PUT http://ushv3.dev/api/v2/sets/1

Code Block
titlePost Data
languagejavascript
{
	
    "name": "Updated Set One",
    "filter": "updated set filter"
}
Code Block
titleResponse
languagejavascript
{
	
    "id": "1",
    "url": "http:\/\/ushv3.dev\/api\/v2\/sets\/1",
    "name": "Updated Set One",
    "filter": "updated set filter",
    "user": null,
    "created": "1970-01-01T00:00:00+00:00",
    "updated": "2013-08-21T00:37:35+00:00"
}

Anchor
delete-id

DELETE sets/:id

...

Panel

DELETE /api/v2/sets/2

Code Block
titleResponse
languagejavascript
{
	
    "id": "1",
    "url": "http:\/\/ushv3.dev\/api\/v2\/sets\/1",
    "name": "Test set",
    "filter": null,
    "user": null,
    "created": "1970-01-01T00:00:00+00:00",
    "updated": "1970-01-01T00:00:00+00:00"
}