Communal establishment management and type

England

Wales

gethttps://crystalroof.co.uk/customer-api/housing/communal-establishment-management-and-type/postcode/v1/{location}

Description

This method returns Census 2021 estimates that classify communal establishment residents in England and Wales by the type of communal establishment they reside in.

A managed communal establishment is a place that provides managed full-time or part-time supervision of residential accommodation.

Examples include:

university halls of residence and boarding schools
care homes, hospitals, hospices and maternity units
hotels, guest houses, hostels and bed and breakfasts, all with residential accommodation for seven or more guests
prisons and other secure facilities
Single Living Accommodation (SLA) in military bases
staff accommodation
religious establishments

It does not include sheltered accommodation, serviced apartments, nurses' accommodation, and houses rented to students by private landlords. These are households.

“Communal establishment management and type” is split into 33 categories including total.

The estimates are as at Census Day, 21 March 2021.

Parameters

Name	Description
location path string	Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. Examples Postcode with or without space. This argument is case-insensitive. Value
area_type query enum	Area types used in Census 2021. The method returns results based on the inclusion of the postcode/coordinate/UPRN within the designated geographical area. For instance, when using 'oa' as a parameter, the returned results will be for the Output Area that contains the specified postcode/coordinate/UPRN. msoa - Middle layer Super Output Area (MSOA), a small geographical area used in the census, comprises 2,000-6,000 households and a population of 5,000 and 15,000 persons. MSOAs are made up of groups of LSOAs, usually four or five. MSOAs fit within local authorities. lad - Local Authority District. There are a total of 296 districts in England made up of 36 metropolitan boroughs, 32 London boroughs, 164 two-tier non-metropolitan districts and 62 unitary authorities, City of London district and Isles of Scilly district. In Wales, there are 22 local authorities, which are named principal areas.. region - nine regions of England (London, the North East, North West, Yorkshire, East Midlands, West Midlands, South East, East of England and the South West) and Wales as a whole. country - constituent countries of the UK: England, Scotland, Wales and Northern Ireland. Value
api_key query enum	Your API key. `DEMO` key allows you to test the method in the `W6 0` postcode sector, or in the `[[51.492, -0.25], [51.502, -0.225]]` rectangle. Value

Request URL:

https://crystalroof.co.uk/customer-api/housing/communal-establishment-management-and-type/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 270,
      "Medical and care establishment": 0,
      "Medical and care establishment:NHS": 0,
      "Medical and care establishment: NHS: General hospital": 0,
      "Medical and care establishment: NHS: Mental health hospital or unit (including secure units)": 0,
      "Medical and care establishment: NHS: Other hospital": 0,
      "Medical and care establishment:Local Authority": 0,
      "Medical and care establishment: Local Authority: Children's home (including secure units)": 0,
      "Medical and care establishment: Local Authority: Care home with nursing": 0,
      "Medical and care establishment: Local Authority: Care home without nursing": 0,
      "Medical and care establishment: Local Authority: Other home": 0,
      "Medical and care establishment:Registered Social Landlord or Housing Association": 0,
      "Medical and care establishment: Registered Social Landlord or Housing Association: Home or hostel": 0,
      "Medical and care establishment:Other": 0,
      "Medical and care establishment: Other: Care home with nursing": 0,
      "Medical and care establishment: Other: Care home without nursing": 0,
      "Medical and care establishment: Other: Children's home (including secure units)": 0,
      "Medical and care establishment: Other: Mental health hospital or unit (including secure units)": 0,
      "Medical and care establishment: Other: Other hospital": 0,
      "Medical and care establishment: Other: Other establishment": 0,
      "Other establishment": 208,
      "Other establishment: Defence": 0,
      "Other establishment: Prison service": 0,
      "Other establishment: Approved premises (probation or bail hostel)": 0,
      "Other establishment: Detention centres and other detention": 0,
      "Other establishment: Education": 202,
      "Other establishment: Hotel, guest house, B&B or youth hostel": 0,
      "Other establishment: Hostel or temporary shelter for the homeless": 6,
      "Other establishment: Holiday accommodation": 0,
      "Other establishment: Other travel or temporary accommodation": 0,
      "Other establishment: Religious": 0,
      "Other establishment: Staff or worker accommodation or Other": 0,
      "Establishment not stated": 62
    },
    "rank": {
      "Medical and care establishment": 0,
      "Medical and care establishment:NHS": 0,
      "Medical and care establishment: NHS: General hospital": 0,
      "Medical and care establishment: NHS: Mental health hospital or unit (including secure units)": 0,
      "Medical and care establishment: NHS: Other hospital": 0,
      "Medical and care establishment:Local Authority": 0,
      "Medical and care establishment: Local Authority: Children's home (including secure units)": 0,
      "Medical and care establishment: Local Authority: Care home with nursing": 0,
      "Medical and care establishment: Local Authority: Care home without nursing": 0,
      "Medical and care establishment: Local Authority: Other home": 0,
      "Medical and care establishment:Registered Social Landlord or Housing Association": 0,
      "Medical and care establishment: Registered Social Landlord or Housing Association: Home or hostel": 0,
      "Medical and care establishment:Other": 0,
      "Medical and care establishment: Other: Care home with nursing": 0,
      "Medical and care establishment: Other: Care home without nursing": 0,
      "Medical and care establishment: Other: Children's home (including secure units)": 0,
      "Medical and care establishment: Other: Mental health hospital or unit (including secure units)": 0,
      "Medical and care establishment: Other: Other hospital": 0,
      "Medical and care establishment: Other: Other establishment": 0,
      "Other establishment": 0,
      "Other establishment: Defence": 0,
      "Other establishment: Prison service": 0,
      "Other establishment: Approved premises (probation or bail hostel)": 0,
      "Other establishment: Detention centres and other detention": 0,
      "Other establishment: Education": 0,
      "Other establishment: Hotel, guest house, B&B or youth hostel": 0,
      "Other establishment: Hostel or temporary shelter for the homeless": 0,
      "Other establishment: Holiday accommodation": 0,
      "Other establishment: Other travel or temporary accommodation": 0,
      "Other establishment: Religious": 0,
      "Other establishment: Staff or worker accommodation or Other": 0,
      "Establishment not stated": 0
    }
  },
  "dataDate": "2021-03-21",
  "refreshedDate": "2021-03-21"
}

401

Unauthorized

{
  "error": "No such API key or it is not valid anymore."
}

402

Payment Required

{
  "error": "You have exhausted the available calls provided by your package."
}

403

Forbidden

{
  "error": "API key is invalid for the given action."
}

404

Not Found

{
  "error": "Can't find such location."
}

429

Too Many Requests

{
  "error": "Too many requests have been sent in one second."
}

500

Internal Server Error

{
  "error": "We have already started working on a resolution!"
}