RSR read partner API

Modified on Fri, 23 Feb at 11:07 AM

Background information The RSR API can be found on this URL, which is based on the Django Rest Framework. In addition, an automatically generated page, by Swagger, shows all API endpoints and their fields: http://rsr.akvo.org/rest/docs/.

API Access

In order to get read access to the API, an API key based on an RSR user is needed. This key can be provided by contacting Akvo staff. An 'Authorization' header should be set with the API key as follows:

Authorization: Token <API key>

Dataset

The full RSR dataset, except for privacy sensitive data like password hashes, is exposed through the RSR API.

Example resource

An example resource, taken from http://rsr.akvo.org/rest/v1/project_update/4684/, will show the following JSON output:

<span class="pl-s"><span class="pl-pds">"</span>locations<span class="pl-pds">"</span></span>: [], <span class="pl-s"><span class="pl-pds">"</span>photo<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>/media/cache/8a/55/8a552db266c27df2239d783aae3b1997.jpg<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>id<span class="pl-pds">"</span></span>: <span class="pl-c1">4684</span>, <span class="pl-s"><span class="pl-pds">"</span>created_at<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>2014-02-11T15:49:33<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>last_modified_at<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>2014-02-11T15:49:33<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>project<span class="pl-pds">"</span></span>: <span class="pl-c1">2</span>, <span class="pl-s"><span class="pl-pds">"</span>user<span class="pl-pds">"</span></span>: <span class="pl-c1">661</span>, <span class="pl-s"><span class="pl-pds">"</span>title<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>Weather Conditions<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>text<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>The heavy rains have come early in Nairobi. January and February are considered the hottest months giving way to rains in March.<span class="pl-cce">\n</span>Rain seems to bring out the worst - traffic, hiked fares, to mention a few.<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>language<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>en<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>primary_location<span class="pl-pds">"</span></span>: <span class="pl-c1">null</span>, <span class="pl-s"><span class="pl-pds">"</span>photo_caption<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>photo_credit<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>video<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>video_caption<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>video_credit<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>update_method<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>M<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>user_agent<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>uuid<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>notes<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>absolute_url<span class="pl-pds">"</span></span>: <span class="pl-s"><span class="pl-pds">"</span>/en/project/2/update/4684/<span class="pl-pds">"</span></span> }

Or the XML version (add format=xml as a parameter):

<<span class="pl-ent">root</span>> <<span class="pl-ent">locations</span>/> <<span class="pl-ent">photo</span>>/media/cache/8a/55/8a552db266c27df2239d783aae3b1997.jpg<!--<span class="pl-ent"-->photo> <<span class="pl-ent">id</span>>4684<!--<span class="pl-ent"-->id> <<span class="pl-ent">created_at</span>>2014-02-11T15:49:33<!--<span class="pl-ent"-->created_at> <<span class="pl-ent">last_modified_at</span>>2014-02-11T15:49:33<!--<span class="pl-ent"-->last_modified_at> <<span class="pl-ent">project</span>>2<!--<span class="pl-ent"-->project> <<span class="pl-ent">user</span>>661<!--<span class="pl-ent"-->user> <<span class="pl-ent">title</span>>Weather Conditions<!--<span class="pl-ent"-->title> <<span class="pl-ent">text</span>> The heavy rains have come early in Nairobi. January and February are considered the hottest months giving way to rains in March. Rain seems to bring out the worst - traffic, hiked fares, to mention a few. <!--<span class="pl-ent"-->text> <<span class="pl-ent">language</span>>en<!--<span class="pl-ent"-->language> <<span class="pl-ent">primary_location</span>/> <<span class="pl-ent">photo_caption</span>/> <<span class="pl-ent">photo_credit</span>/> <<span class="pl-ent">video</span>/> <<span class="pl-ent">video_caption</span>/> <<span class="pl-ent">video_credit</span>/> <<span class="pl-ent">update_method</span>>M<!--<span class="pl-ent"-->update_method> <<span class="pl-ent">user_agent</span>/> <<span class="pl-ent">uuid</span>/> <<span class="pl-ent">notes</span>/> <<span class="pl-ent">absolute_url</span>>/en/project/2/update/4684/<!--<span class="pl-ent"-->absolute_url> <!--<span class="pl-ent"-->root>

Filters and parameters

It is possible for any resource to filter on several fields, such as project or partner, by adding a parameter with the id of the object. E.g.

?project=2

to filter on project id 2. In addition, there are several standard parameters that go for every resource:

format: Either json or xml. Defaults to html.
limit: The number of objects per page. Defaults to 30, with a max of 100.
ordering: Order on any field. Prepend an '-' to reverse ordering.

API code of conduct

When using the Akvo RSR API, please respect our API Code of Conduct.