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

Obtain a UPRN from a Royal Mail UDPRN or UMRRN

The following request demonstrates how to purchase a UPRN, when you have either a Royal Mail UDPRN or UMRRN (e.g. 23944305) in hand.

Request:

POST /world/GB/delivery-points/23944305/catalog HTTP/1.1
Host: api.whenfresh.com
Authorization: Bearer [YOUR_ACCESS_TOKEN]
Content-Type: application/ld+json
Accept: application/ld+json
{
  "@context": "http://api.whenfresh.com/.hydra/context.jsonld",
  "@type": "PurchaseVariableAction",
  "variables": [
    "https://api.whenfresh.com/vars/WhenFresh/Address#Ordnance Survey/Spatial/Address/Unique Property Reference Number"
  ]
}

Response:

{
  "@context": "https://api.whenfresh.com/.hydra/context.jsonld",
  "@type": "ResourceCatalogPurchase",
  "manages": {
    "property": "rdf:type",
    "object": "Datum"
  },
  "member": [
    {
      "@type": "https://api.whenfresh.com/ontologies/Ordnance Survey/Spatial#Address/Unique Property Reference Number",
      "value": "100022659168",
      "variable": {
        "@id": "https://api.whenfresh.com/vars/WhenFresh/Address#Ordnance Survey/Spatial/Address/Unique Property Reference Number",
        "@type": "Variable"
      }
    }
  ],
  "totalItems": 1
}
  • Improve this Doc