API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
- Reinstatements
Assets
- Vehicles
Admin
- IAM
Property Model
The type of resource
properties "properties"
The property ID
"7e0c875a-fd47-401d-bd25-4278ed58d721"
The Unique Property Reference Number
10022999531
The property address
The country of the property
"United Kingdom"
The department of the organisation if this property is commercial
"Finance"
The dependent thoroughfare of the property
"Dependent Thoroughfare Name"
A description of the property which is searchable via a typeahead
"Saltmeadows Rd, Gateshead NE8 3AH"
The name of the property
"Highway House"
The number of the property
"1A"
The name of the organisation
"Ctrl Hub Limited"
If the address has a POBox, it will be present here
"PO Box 123"
The postal town of the property
"Gateshead"
The postcode of the property
"NE8 3AH"
The thoroughfare of the property
"Saltmeadows Rd"
The MPRN at the property
1515151
The MPAN at the property
5151515
The PSR details of the property
Whether the property is on the PSR or not
true
The contact details of the PSR customer
"A Person (07970 111 222)"
The priority of the vulnerable customer. This is 0 when there is no priority.
0, 1, 2, 3 1
Any notes about the vulnerable customer which will potentially include the Needs Codes
"14Pensioner"
{
"type": "properties",
"id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
"attributes": {
"uprn": 10022999531,
"address": {
"country": "United Kingdom",
"department": "Finance",
"dependent_thoroughfare": "Dependent Thoroughfare Name",
"description": "Saltmeadows Rd, Gateshead NE8 3AH",
"name": "Highway House",
"number": "1A",
"organisation": "Ctrl Hub Limited",
"pobox": "PO Box 123",
"post_town": "Gateshead",
"postcode": "NE8 3AH",
"thoroughfare": "Saltmeadows Rd"
},
"location": {
"coordinates": [
-1.587305,
54.966
],
"type": "Point"
},
"mprn": 1515151,
"mpan": 5151515,
"psr": {
"indicator": true,
"contact": "A Person (07970 111 222)",
"priority": 1,
"notes": "14Pensioner"
}
}
}