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/?format=api
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 23,
    "next": "http://dev.oipa.nl/api/regions/?format=api&page=2",
    "previous": null,
    "results": [
        {
            "url": "http://dev.oipa.nl/api/regions/189/?format=api",
            "code": "189",
            "name": "North of Sahara, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/289/?format=api",
            "code": "289",
            "name": "South of Sahara, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/298/?format=api",
            "code": "298",
            "name": "Africa, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/380/?format=api",
            "code": "380",
            "name": "West Indies, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/389/?format=api",
            "code": "389",
            "name": "North & Central America, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/489/?format=api",
            "code": "489",
            "name": "South America, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/498/?format=api",
            "code": "498",
            "name": "America, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/589/?format=api",
            "code": "589",
            "name": "Middle East, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/619/?format=api",
            "code": "619",
            "name": "Central Asia, regional"
        },
        {
            "url": "http://dev.oipa.nl/api/regions/66/?format=api",
            "code": "66",
            "name": "Arab States"
        }
    ]
}