• My Account
  • Docs
  • Catalog
  • Status
Show / Hide Table of Contents

Retrieving the Catalog for a Postal Address

The following request demonstrates how to retrieve the catalog variables for a postal address. It requires a postal address's catalog link obtained (for example) by Getting Postal Addresses for a Postcode.

GET /world/GB/addresses/8e05p%C2%B70/catalog HTTP/1.1
Host: api.whenfresh.com
Authorization: Bearer [YOUR_ACCESS_TOKEN]
Accept: application/ld+json

The returned Catalog comprises a list of JSON Variable resources:

HTTP/1.1 200 OK
Content-Type: application/ld+json
{
  "@id": "https://api.whenfresh.com/world/GB/addresses/8e05p·0/catalog",
  "@context": "https://api.whenfresh.com/.hydra/context.jsonld",
  "@type": "Catalog",
  "member": [
    {
      "@type": "https://api.whenfresh.com/ontologies/Dwelling/Rooms#Bedrooms/Bedroom Count",
      "price": {
        "value": 1,
        "currency": "GBP"
      },
      "variable": {
        "@id": "https://api.whenfresh.com/vars/WhenFresh/Property Attribute#Dwelling/Rooms/Bedrooms/Bedroom Count",
        "@type": "Variable"
      }
    },
    {
      "@type": "https://api.whenfresh.com/ontologies/Dwelling/Rooms#Bathrooms/Bathroom Count",
      "price": {
        "value": 1,
        "currency": "GBP"
      },
      "variable": {
        "@id": "https://api.whenfresh.com/vars/Zoopla/Property Attribute#Dwelling/Rooms/Bathrooms/Bathroom Count",
        "@type": "Variable"
      }
    }
  ]
}
  • Improve this Doc