Set cycle auto raise
curl --request POST \
--url https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"autoRaise": true
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', expectedRevision: 123, autoRaise: true})
};
fetch('https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"autoRaise": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"category": "servicing",
"status": "active",
"templateId": "<string>",
"recurrenceInterval": 123,
"recurrenceUnit": "day",
"anchorMonth": 123,
"anchorDay": 123,
"repeatsLabel": "<string>",
"properties": 123,
"nextRunOn": "<string>",
"overdue": 123,
"dueThisMonth": 123,
"accessIssues": 123,
"nextBatch": {
"month": "<string>",
"count": 123
},
"contractorContactId": "<string>",
"contractorName": "<string>",
"perJobMinor": 123,
"autoRaise": true,
"autoRaiseSetAt": "<string>",
"rules": {
"raiseLeadDays": 123,
"tenantNoticeHours": 123,
"landlordApprovalAboveMinor": 123,
"skipIfDoneWithinMonths": 123
},
"budgetLineId": "<string>",
"notes": "<string>",
"revision": 123,
"createdAt": "<string>",
"updatedAt": "<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>"
}planned-maintenance
Set cycle auto raise
Switch auto-raise: each place’s job is instructed to the cycle’s contractor on its raise day (Maintenance Pro; a task otherwise)
POST
/
planned-maintenance
/
cycles
/
{id}
/
auto-raise
Set cycle auto raise
curl --request POST \
--url https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"autoRaise": true
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', expectedRevision: 123, autoRaise: true})
};
fetch('https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/planned-maintenance/cycles/{id}/auto-raise"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"autoRaise": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"category": "servicing",
"status": "active",
"templateId": "<string>",
"recurrenceInterval": 123,
"recurrenceUnit": "day",
"anchorMonth": 123,
"anchorDay": 123,
"repeatsLabel": "<string>",
"properties": 123,
"nextRunOn": "<string>",
"overdue": 123,
"dueThisMonth": 123,
"accessIssues": 123,
"nextBatch": {
"month": "<string>",
"count": 123
},
"contractorContactId": "<string>",
"contractorName": "<string>",
"perJobMinor": 123,
"autoRaise": true,
"autoRaiseSetAt": "<string>",
"rules": {
"raiseLeadDays": 123,
"tenantNoticeHours": 123,
"landlordApprovalAboveMinor": 123,
"skipIfDoneWithinMonths": 123
},
"budgetLineId": "<string>",
"notes": "<string>",
"revision": 123,
"createdAt": "<string>",
"updatedAt": "<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