GET /api/v1/countries
List Geography Mandates

Examples

GET /api/v2/geographies
200
{
  "data": [
    {
      "id": "21",
      "type": "geographies",
      "links": {
        "self": "http://test.host/api/v2/geographies/21"
      },
      "attributes": {
        "slug": "global-emerging-markets",
        "useful-links": [],
        "name": "Global Emerging Markets"
      },
      "relationships": {
        "classification-distribution": {
          "links": {
            "self": "http://test.host/api/v2/geographies/21/relationships/classification-distribution",
            "related": "http://test.host/api/v2/geographies/21/classification-distribution"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/geographies/21/relationships/countries",
            "related": "http://test.host/api/v2/geographies/21/countries"
          }
        }
      }
    },
    {
      "id": "22",
      "type": "geographies",
      "links": {
        "self": "http://test.host/api/v2/geographies/22"
      },
      "attributes": {
        "slug": "asean",
        "useful-links": [],
        "name": "Asean"
      },
      "relationships": {
        "classification-distribution": {
          "links": {
            "self": "http://test.host/api/v2/geographies/22/relationships/classification-distribution",
            "related": "http://test.host/api/v2/geographies/22/classification-distribution"
          }
        },
        "countries": {
          "links": {
            "self": "http://test.host/api/v2/geographies/22/relationships/countries",
            "related": "http://test.host/api/v2/geographies/22/countries"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 2
  }
}

GET /api/v1/countries/:id
Show a Geography Mandate

Examples

GET /api/v2/geographies/19
200
{
  "data": {
    "id": "19",
    "type": "geographies",
    "links": {
      "self": "http://test.host/api/v2/geographies/19"
    },
    "attributes": {
      "slug": "global-emerging-markets",
      "useful-links": [],
      "name": "Global Emerging Markets"
    },
    "relationships": {
      "classification-distribution": {
        "links": {
          "self": "http://test.host/api/v2/geographies/19/relationships/classification-distribution",
          "related": "http://test.host/api/v2/geographies/19/classification-distribution"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/geographies/19/relationships/countries",
          "related": "http://test.host/api/v2/geographies/19/countries"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Geography ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/countries
Create a Geography Mandate


PATCH /api/v2/countries/:id
Update a Geography Mandate

Params

Param name Description
id
required

Geography ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/countries/:id
Delete a Geography Mandate

Params

Param name Description
id
required

Geography ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.