Documentation

General api information

Error responses

400 Bad Request

{
  "errors": [
    {
      "status": 400,
      "detail": "data.attributes.uprn is required"
    },
    {
      "status": 400,
      "detail": "data.attributes.agents is required"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

401 Unauthorized

{
  "errors": [
    {
      "status": "401",
      "detail": "Authentication credentials were missing or incorrect"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

403 Forbidden

{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

404 Not Found

{
  "errors": [
    {
      "status": "404",
      "detail": "Resource does not exist"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "status": "500",
      "detail": "Internal Server Error"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

Lookup values not present in model

Amenities

24 Hour Access
24 Hour Security
24-Hour Porterage
4 Pipe Fan Coil Air Conditioning
Abuts Railway
Air Conditioning
Alarm
ATMs
Atrium
Baby Facilities
Bicycle Facilities
Bowling alley
BREEAM excellent
BREEAM outstanding
BREEAM very good
Broadband
Building Reception
Bulky Goods Planning Consent
Car wash
Carpeted Offices
Cat II Lighting
Cat V Cabling
CCTV
Central Heating
Chapel
Cinema
Comfort Cooling
Commissionaire
Concierge
Creche
Customer Card
Customer Services Desk
Dentist
Disabled Access
Disabled Parking
Disabled Toilets
Dockside
Double Glazing
Electric Heating
Entry Phone
Escalator(s)
Events Programme
Food Court
Fully fitted out
Gated Development
Goods lift(s)
Gym
Heritage Centre
Ice Rink
Information point
Kiosks/barrow Traders
Kitchenette
Landscaped Garden(s)
Leisure/Sports Facilities
LG3 Lighting
LG7 Lighting
Library
Lift/s
Loading bay(s)
Marble Ceilings
Medical centre
Metal Ceilings
Mutliplex cinema
Natural Light
Nightclub
Open Planning Consent
Park 'n Ride Facilities
Parking Spaces
Perimeter Trunking
Petrol Station
Play centre
Police station (on-site)
Public Transport Interchange
Raised Floors
Recycling facilities
River/Canalside
Roller Shutter Access
Roof Terrace
Security
Separate Entrance
Separate Kitchen
Shell/Loft Apartments
Shopmobility
Shopper lockers
Shoppertainment Programme
Shower/s
Stairs
Storage
Supermarket
Suspended Ceilings
Swimming Pool
Taxi rank
Three-Phase Power
Toilets
Tourist Office
Under Floor Trunking
VAV Air Conditioning
Versatemp Air Cooling
WC's on each floor
WCs
WiredScore Gold
WiredScore Platinum
WiredScore Silver
Wooden Floors