Attach decant file
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/files \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentId": "<string>",
"caption": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({documentId: '<string>', caption: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/files', 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}/files"
payload = {
"documentId": "<string>",
"caption": "<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"
}
]
},
"stages": [
{
"stage": "overview",
"label": "<string>",
"status": "<string>",
"tone": "neutral",
"lastUpdateOn": "<string>",
"nextAction": "<string>",
"dueOn": "<string>"
}
],
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"activity": [
{
"id": "<string>",
"at": "<string>",
"stage": "overview",
"stageLabel": "<string>",
"entry": "<string>",
"recordedBy": "<string>"
}
],
"costs": {
"accommodationMinor": 123,
"allowancesMinor": 123,
"totalMinor": 123,
"coverRemainingMinor": 123
},
"contacts": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<string>"
}
],
"linked": {
"repair": {
"id": "<string>",
"reference": "<string>"
},
"workOrder": {
"id": "<string>",
"reference": "<string>"
},
"claimReference": "<string>"
},
"documents": [
{
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"caption": "<string>",
"purpose": "document",
"addedOn": "<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
Attach decant file
Attach an uploaded document or inspection photo to a decant case
POST
/
maintenance-pro
/
decants
/
{id}
/
files
Attach decant file
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/decants/{id}/files \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentId": "<string>",
"caption": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({documentId: '<string>', caption: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/decants/{id}/files', 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}/files"
payload = {
"documentId": "<string>",
"caption": "<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"
}
]
},
"stages": [
{
"stage": "overview",
"label": "<string>",
"status": "<string>",
"tone": "neutral",
"lastUpdateOn": "<string>",
"nextAction": "<string>",
"dueOn": "<string>"
}
],
"household": [
{
"name": "<string>",
"relationship": "<string>",
"age": 123,
"needs": "<string>",
"contactId": "<string>"
}
],
"activity": [
{
"id": "<string>",
"at": "<string>",
"stage": "overview",
"stageLabel": "<string>",
"entry": "<string>",
"recordedBy": "<string>"
}
],
"costs": {
"accommodationMinor": 123,
"allowancesMinor": 123,
"totalMinor": 123,
"coverRemainingMinor": 123
},
"contacts": [
{
"name": "<string>",
"role": "<string>",
"phone": "<string>",
"email": "<string>"
}
],
"linked": {
"repair": {
"id": "<string>",
"reference": "<string>"
},
"workOrder": {
"id": "<string>",
"reference": "<string>"
},
"claimReference": "<string>"
},
"documents": [
{
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"caption": "<string>",
"purpose": "document",
"addedOn": "<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