Property boards hmos
curl --request GET \
--url https://api.sortx.co.uk/property-boards/hmos \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/hmos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/hmos"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"cards": [
{
"propertyId": "<string>",
"address": "<string>",
"licence": {
"documentId": "<string>",
"type": "mandatory_hmo",
"typeLabel": "<string>",
"council": "<string>",
"holderName": "<string>",
"number": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"endsLabel": "<string>"
},
"term": {
"left": "<string>",
"daysLeft": 123,
"usedPct": 123,
"warn": true
},
"rooms": {
"total": 123,
"occupied": 123,
"maxOccupants": 123,
"tiles": [
{
"unitId": "<string>",
"number": "<string>",
"label": "<string>",
"occupied": true
}
]
},
"checks": [
{
"key": "fire_alarm_test",
"label": "<string>",
"state": "ok",
"note": "<string>"
}
],
"renewal": {
"applicationId": "<string>",
"stage": "<string>"
},
"action": "conditions",
"actionLabel": "<string>"
}
],
"withheld": [
"<string>"
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}property-boards
Property boards hmos
HMOs: each licence and its term, room occupancy and the fire safety checks the licence asks for
GET
/
property-boards
/
hmos
Property boards hmos
curl --request GET \
--url https://api.sortx.co.uk/property-boards/hmos \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/hmos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/hmos"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"cards": [
{
"propertyId": "<string>",
"address": "<string>",
"licence": {
"documentId": "<string>",
"type": "mandatory_hmo",
"typeLabel": "<string>",
"council": "<string>",
"holderName": "<string>",
"number": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"endsLabel": "<string>"
},
"term": {
"left": "<string>",
"daysLeft": 123,
"usedPct": 123,
"warn": true
},
"rooms": {
"total": 123,
"occupied": 123,
"maxOccupants": 123,
"tiles": [
{
"unitId": "<string>",
"number": "<string>",
"label": "<string>",
"occupied": true
}
]
},
"checks": [
{
"key": "fire_alarm_test",
"label": "<string>",
"state": "ok",
"note": "<string>"
}
],
"renewal": {
"applicationId": "<string>",
"stage": "<string>"
},
"action": "conditions",
"actionLabel": "<string>"
}
],
"withheld": [
"<string>"
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}