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.

...

Resource

Description

POST rivers

Create a river

GET rivers/:river_id

Returns a single river, specified by the id parameter

PUT rivers/:river_id

Edit a river

DELETE rivers/:river_id

Deletes the river specified by the id parameter

POST rivers/:id/channels

Add a channel to a river.

PUT rivers/:id/channels/:channel_id

Modify the eixsting channel specified by channel_id in the river

DELETE rivers/:id/channels/:channel_id

Deletes the channel with the specified channel_id from the river

POST rivers/:id/collaborators

Adds a collaborator to the river

GET rivers/:id/collaborators

Returns the list of users collaborating on the river specified by the id parameter

PUT rivers/:id/collaborators/:collaboratoraccount_id

Modify the collaborator with the specified user_id in the river specified by the id parameter

DELETE rivers/:id/collaborators/:collaboratoraccount_id

Removes the collaborator with the specified user_id from the list of collaborators for the river specified by the id parameter

PUT rivers/:id/followers/:account_id

Add a follower to a river.

GET rivers/:id/followers

Returns the list of users following the river specified by the id parameter

DELETE rivers/:id/followers/follower_id

Remove the specified follower.

GET rivers/:id/drops

Returns drops in the river specified by the id parameter

DELETE rivers/:id/drops/:drop_id

Deletes the drop with the specified drop_id from the river, specified by the id parameter

POST rivers/:id/subscriptions

Add a subscription to the river.

GET rivers/:id/subscriptions

Returns the list of subscriptions the account has registered on the river.

PUT rivers/:id/subscriptions

Modify an existing subscription.

DELETE rivers/:id/subscriptions/subscription_id

Delete a subscription from the river.

GET rivers/:id/trends/tags

Returns the trending tags in the river specified by the id parameter
GET rivers/:id/trends/placesReturns the trending places in the river specified by the id parameter

GET rivers/:id/rules

Gets the drop processing rules for the river specified by the id parameter

POST rivers/:id/rules

Adds a rule to the river specified by the id parameter

PUT rivers/:id/rules/:rule_id

Modifies the rule with the specified rule_id in the river specified by the id parameter

DELETE rivers/:id/rules/:rule_id

Deletes the rule with the specified rule_id from the list of rules for the river specified by the id parameter

...