The admin api has been designed to specially handle most of the administrative task handled by the administrator of the Ushahidi deployment. All admin API request requires an HTTP authentication which means for any request you make to any of the admin API call, you have to provide your Ushahidi admin username and password to the HTTP client before you can get the intended response. The server sends a 401 Authentication Required header to prompt for username and password.
All the admin API tasks in the table below have “Requires admin authentication.” appended to the them and they are all POST request and it's shipped with Ushahidi version 2.1 and above.
Administrative tasks on reports are performed by sending a HTTP POST request to the base URL with report as the task parameter
http://<deployment_url>/api?task=reports |
In addition to the task parameter, one of the following action request parameters MUST also be specified
Parameter | Description | Example |
|---|---|---|
delete | Deletes the report with the specified incident_id from the system |
|
approve | Approves the report with the specified incident_id |
|
verify | Verifies the report with the specified incident_id |
|
edit | Edits an existing report. Parameters required are listed below |
|
&action=edit)When editing a report, the following parameters must be specifed in the request.
Parameter | Description | Example |
|---|---|---|
incident_id | ID of the report to be edited |
|
incident_title | Title of the report |
|
incident_description | Description of the report |
|
incident_date | Date of the report (in mm/dd/yyyy) format |
|
incident_hour | Hour component (in 12 hour format) of the time when the event being reported took place |
|
incident_minute | Minute component of the time the event being reported took place |
|
incident_ampm | Whether the event took place in the AM or PM |
|
latitude | Latitude component of the report location |
|
longitude | Longitude component of the report location |
|
location_name | Name of the location association where the event took place |
|
location_id | ID of the location associated with the report |
|
incident_active | Whether the report has been approved (0 - Not approved, 1 - Approved) |
|
incident_verified | Whether the report has been verified (0 - Not verified, 1 - Verified) |
|
| incident_category | List of category ids (list must contain at least 1 category) | &incident_category=12,45,3 |
Parameter | Description | Example |
|---|---|---|
person_first | First name of the person who submitted the report |
|
person_last | Last name of the person who submitted the report |
|
person_email | Email address of the person who submitted the report |
|
incident_photo[] | Photo(s) associated with the report | None |
incident_news | A URL to a news or other website link that is associated with the report | None |
incident_video | Optional A URL to a video related to the report | None |
A comment to a report is submitted by sending a HTTP POST request to the base URL with comments as the task parameter
http://<deployment_url>/api?task=comments |
When submitting a comment via the Admin API, the following parameters MUST be specified:
Parameter | Description | Example |
|---|---|---|
incident_id | ID of the report under which the comment is being submitted |
|
checkin_id | ID of the checkin to post the comment on (when not using incident_id) |
|
comment_author | Name of person posting the comment |
|
comment_description | Details of the comment |
|
comment_email | Email address of the person submitting the comment |
|
NOTE: As of v2.2 of the platform, comment_email and comment_author are not necessary if the comment is being submitted by an already authenticated user. If specified, they shall be overwritten with the details of the authenticated user.
Administrative tasks on categories are performed by sending a HTTP POST to the base URL with category as the task parameter.
http://<deployment_url>/api?task=category |
In addition to the task parameter, one of the following action parameters must also be specified
Parameter | Description | Example |
|---|---|---|
add | Creates a new category |
|
edit | Edits an existing category. The id of the category to be edited must also be specified |
|
delete | Deletes an existing category. The id of the category to be deleted must also be specified |
|
&action=add and &action=edit)Parameter | Description | Example |
|---|---|---|
category_id | ID of the category - Only when a category is being edited |
|
parent_id | ID of the parent category or 0 when you want the new category to be the parent category |
|
category_title | Title of the category |
|
category_description | Description of the category |
|
category_color | Hex value of the color to be used to visually identify the category |
|
category_image | Optional Path to an image that shall serve as the category's icon | None |