A pact between GDS API Adapters and Whitehall API

Requests from GDS API Adapters to Whitehall API

• A request to return a countries worldwide organisations given a worldwide organisation exists

• A request to return a specific world location given a world location exists

• A request to return all world locations given a world location exists

Interactions

Given a worldwide organisation exists, upon receiving a request to return a countries worldwide organisations from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/world-locations/france/organisations",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/80.0.1 ()"
  }
}

Whitehall API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "results": [
      {
        "id": "https://www.gov.uk/api/worldwide-organisations/british-embassy-paris",
        "title": "British Embassy Paris",
        "format": "Worldwide Organisation",
        "updated_at": "2014-05-13T10:15:06.000+01:00",
        "web_url": "https://www.gov.uk/world/organisations/british-embassy-paris",
        "details": {
          "slug": "british-embassy-paris"
        },
        "analytics_identifier": "WO49",
        "sponsors": [
          {
            "title": "Foreign, Commonwealth & Development Office",
            "web_url": "https://www.gov.uk/government/organisations/foreign-commonwealth-development-office",
            "details": {
              "acronym": "FCDO"
            }
          }
        ]
      }
    ]
  }
}

Given a world location exists, upon receiving a request to return a specific world location from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/world-locations/france",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/80.0.1 ()"
  }
}

Whitehall API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "id": "https://www.gov.uk/api/world-locations/france",
    "title": "France",
    "format": "World location",
    "updated_at": "2020-09-02T06:47:34.000+01:00",
    "web_url": "https://www.gov.uk/world/france",
    "analytics_identifier": "WL1",
    "details": {
      "slug": "france",
      "iso2": null
    },
    "organisations": {
      "id": "https://www.gov.uk/api/world-locations/france/organisations",
      "web_url": "https://www.gov.uk/world/france#organisations"
    },
    "content_id": "5e9ecbce-7706-11e4-a3cb-005056011aef"
  }
}

Given a world location exists, upon receiving a request to return all world locations from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/world-locations",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/80.0.1 ()"
  }
}

Whitehall API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "results": [
      {
        "id": "https://www.gov.uk/api/world-locations/france",
        "title": "France",
        "format": "World location",
        "updated_at": "2020-09-02T06:47:34.000+01:00",
        "web_url": "https://www.gov.uk/world/france",
        "analytics_identifier": "WL1",
        "details": {
          "slug": "france",
          "iso2": null
        },
        "organisations": {
          "id": "https://www.gov.uk/api/world-locations/france/organisations",
          "web_url": "https://www.gov.uk/world/france#organisations"
        },
        "content_id": "5e9ecbce-7706-11e4-a3cb-005056011aef"
      }
    ]
  }
}