Decant cases
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/decants \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/decants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/decants"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"reviewsDueBy": "<string>",
"metrics": {
"householdsAway": 123,
"homesWithMeasures": 123,
"allowancesOutstandingMinor": 123,
"reviewsDueSoon": 123
},
"typeCounts": {
"all": 123,
"temporary_decant": 123,
"permanent_decant": 123,
"interim_measures": 123
},
"cases": [
{
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": "<string>",
"type": "temporary_decant",
"startOn": "<string>",
"endOn": "<string>",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"funding": "building_insurer",
"costToDateMinor": 123,
"status": "scheduled",
"open": true,
"repairId": "<string>",
"repairReference": "<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>"
}maintenance-pro
Decant cases
The decant cases with the list’s tiles and type counts; open by default
GET
/
maintenance-pro
/
decants
Decant cases
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/decants \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/decants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/decants"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"reviewsDueBy": "<string>",
"metrics": {
"householdsAway": 123,
"homesWithMeasures": 123,
"allowancesOutstandingMinor": 123,
"reviewsDueSoon": 123
},
"typeCounts": {
"all": 123,
"temporary_decant": 123,
"permanent_decant": 123,
"interim_measures": 123
},
"cases": [
{
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": "<string>",
"type": "temporary_decant",
"startOn": "<string>",
"endOn": "<string>",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"funding": "building_insurer",
"costToDateMinor": 123,
"status": "scheduled",
"open": true,
"repairId": "<string>",
"repairReference": "<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>"
}