A pact between GDS API Adapters and Imminence API

Requests from GDS API Adapters to Imminence API

• The request to retrieve all places for the current dataset given a service exists called number-plate-supplier with places

• The request to retrieve the area for the given postcode given a place exists with a postcode and areas

Interactions

Given a service exists called number-plate-supplier with places, upon receiving the request to retrieve all places for the current dataset from GDS API Adapters, with

{
  "method": "get",
  "path": "/places/number-plate-supplier.json",
  "query": "lat=-2.01&lng=53.1&limit=5",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/75.3.0 ()"
  }
}

Imminence API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": [
    {
      "_id": {
        "$oid": "60867a0ee90e0703aed18e46"
      },
      "access_notes": null,
      "address1": "Yarrow Road Tower Park",
      "address2": null,
      "data_set_version": 473,
      "email": null,
      "fax": null,
      "general_notes": null,
      "geocode_error": null,
      "location": {
        "longitude": -1.9552618901330387,
        "latitude": 50.742754933617285
      },
      "name": "Breeze Motor Co Ltd",
      "override_lat": null,
      "override_lng": null,
      "phone": "01202 713000",
      "postcode": "BH12 4QY",
      "service_slug": "number-plate-supplier",
      "snac": null,
      "source_address": "Yarrow Road Tower Park Poole  BH12 4QY",
      "text_phone": null,
      "town": "Yarrow",
      "url": null
    }
  ]
}

Given a place exists with a postcode and areas, upon receiving the request to retrieve the area for the given postcode from GDS API Adapters, with

{
  "method": "get",
  "path": "/areas/WC2B%206SE.json",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/75.3.0 ()"
  }
}

Imminence API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "_response_info": {
      "status": "ok",
      "links": [

      ]
    },
    "total": 2,
    "start_index": 1,
    "page_size": 2,
    "current_page": 1,
    "pages": 1,
    "results": [
      {
        "name": "Westminster City Council",
        "country_name": "England",
        "type": "LBO",
        "codes": {
          "gss": "E12000008"
        }
      },
      {
        "name": "London",
        "country_name": "England",
        "type": "EUR",
        "codes": {
          "gss": "E12000009"
        }
      }
    ]
  }
}