Region List

Returns a list of IATI Regions stored in OIPA.

Request parameters

  • fields (optional): List of fields to display
  • fields[aggregations] (optional): Aggregate available information. See Available aggregations section for details.

Available aggregations

API request may include fields[aggregations] parameter. This parameter controls result aggregations and can be one or more (comma separated values) of:

  • total_budget: Calculate total budget of activities presented in regions activities list.
  • disbursement: Calculate total disbursement of activities presented in regions activities list.
  • commitment: Calculate total commitment of activities presented in regions activities list.

Result details

Each result item contains short information about region including URI to region details.

URI is constructed as follows: /api/regions/{region_id}

GET /api/regions/?page=2
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 23,
    "next": "http://dev.oipa.nl/api/regions/?page=3",
    "previous": "http://dev.oipa.nl/api/regions/",
    "results": [
        {
            "url": "http://dev.oipa.nl/api/regions/67/",
            "code": "67",
            "name": "Africa"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/679/",
            "code": "679",
            "name": "South Asia, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/68/",
            "code": "68",
            "name": "Asia & the Pacific"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/689/",
            "code": "689",
            "name": "South & Central Asia, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/69/",
            "code": "69",
            "name": "Europe and North America"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/70/",
            "code": "70",
            "name": "Latin America and the Caribbean"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/789/",
            "code": "789",
            "name": "Far East Asia, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/798/",
            "code": "798",
            "name": "Asia, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/88/",
            "code": "88",
            "name": "States Ex-Yugoslavia unspecified"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/889/",
            "code": "889",
            "name": "Oceania, regional"
        }
    ]
}