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

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

Example

sinceid

Least report id that should be returned

&by=sinceid&id=10

maxid

Maximum report id that should be returned

&by=maxid&id=500

incidentid

Retrieve a single report using its id

&by=incidentid&id=50

locname

Get reports tagged with a specific location name

&by=locname&name=Nairobi

locid

Get reports tagged with a location with the specified id

&by=locid&id=12

cat name

Get reports that belong to a specified category name

&by=catname&name=Health

catid

Get reports that belong to a category with a id

&by=catid&id=12

Returned Values

API The reports request returns JSON with top-level fields payload, error.  

  • The error field contains message, code;  a reports list with no errors should contain message="No Error" and code=0. 
  • The payload field contains the reports list, and has top-level fields domain, incidents.  Domain contains the URL of the ushahidi instance; incidents contains the list of reports.  So if your API result goes into variable "result", your incidents list will be in result['payload']['incidents']
  • The top-level fields returned for each incident are media, incident, customfields, comments, categories.
  • The fields in incident are:

Parameter

Description

Example

incidentid  
incidenttitle  
incidentdescription  
incidentdate  
incidentactiveFlag for report approved1=approved, 0=unapproved
incidentverifiedFlag for report verified1=verified, 0-unverified
incidentmodeMethod of report submission1=web, 2=sms, 3=email, 4=twitter
locationid  
locationname  
locationlatitude  
locationlongitude  

 

Submitting a Report

...

A report is submitted by sending a HTTP POST request to the base URL with report as the task parameter. Additionally, the following parameters must also be specified

...