Save decant assessment
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/assessment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hazard: {
hazard: '<string>',
source: '<string>',
reportedAt: '<string>',
inspectedAt: '<string>',
inspectedBy: '<string>',
electrics: '<string>'
},
rooms: [{room: '<string>', condition: '<string>'}],
amenities: [
{
amenity: '<string>',
available: '<string>',
lostFrom: '<string>',
expectedBack: '<string>'
}
],
needs: [{need: '<string>', person: '<string>', detail: '<string>'}]
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/assessment', 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/{id}/assessment"
payload = {
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"case": {
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"householdLabel": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"type": "temporary_decant",
"status": "scheduled",
"startOn": "<string>",
"expectedEndOn": "<string>",
"ownerUserId": "<string>",
"ownerName": "<string>",
"funding": "building_insurer",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"claimReference": "<string>",
"closedAt": "<string>",
"tabs": [
{
"stage": "overview",
"label": "<string>",
"subtitle": "<string>",
"tone": "neutral"
}
]
},
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>",
"usable": "yes"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
],
"decision": {
"arrangement": "temporary_decant",
"reason": "<string>",
"estimatedDuration": "<string>",
"decidedBy": "<string>",
"decidedOn": "<string>",
"landlordConsent": "given",
"savedAt": "<string>"
},
"photos": [
{
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"caption": "<string>",
"purpose": "document",
"addedOn": "<string>"
}
],
"history": [
{
"on": "<string>",
"entry": "<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
Save decant assessment
Save the hazard, rooms, loss of amenity and household needs
POST
/
maintenance-pro
/
decants
/
{id}
/
assessment
Save decant assessment
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/assessment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hazard: {
hazard: '<string>',
source: '<string>',
reportedAt: '<string>',
inspectedAt: '<string>',
inspectedBy: '<string>',
electrics: '<string>'
},
rooms: [{room: '<string>', condition: '<string>'}],
amenities: [
{
amenity: '<string>',
available: '<string>',
lostFrom: '<string>',
expectedBack: '<string>'
}
],
needs: [{need: '<string>', person: '<string>', detail: '<string>'}]
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/assessment', 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/{id}/assessment"
payload = {
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"case": {
"id": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"propertyAddress": "<string>",
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"householdLabel": "<string>",
"repairId": "<string>",
"repairReference": "<string>",
"workOrderId": "<string>",
"workOrderReference": "<string>",
"type": "temporary_decant",
"status": "scheduled",
"startOn": "<string>",
"expectedEndOn": "<string>",
"ownerUserId": "<string>",
"ownerName": "<string>",
"funding": "building_insurer",
"lossOfAmenity": "<string>",
"arrangement": "<string>",
"claimReference": "<string>",
"closedAt": "<string>",
"tabs": [
{
"stage": "overview",
"label": "<string>",
"subtitle": "<string>",
"tone": "neutral"
}
]
},
"hazard": {
"hazard": "<string>",
"source": "<string>",
"reportedAt": "<string>",
"inspectedAt": "<string>",
"inspectedBy": "<string>",
"electrics": "<string>"
},
"rooms": [
{
"room": "<string>",
"condition": "<string>",
"usable": "yes"
}
],
"amenities": [
{
"amenity": "<string>",
"available": "<string>",
"lostFrom": "<string>",
"expectedBack": "<string>"
}
],
"needs": [
{
"need": "<string>",
"person": "<string>",
"detail": "<string>"
}
],
"decision": {
"arrangement": "temporary_decant",
"reason": "<string>",
"estimatedDuration": "<string>",
"decidedBy": "<string>",
"decidedOn": "<string>",
"landlordConsent": "given",
"savedAt": "<string>"
},
"photos": [
{
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"caption": "<string>",
"purpose": "document",
"addedOn": "<string>"
}
],
"history": [
{
"on": "<string>",
"entry": "<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>"
}Authorizations
Body
application/json
Response
Success