Cycle
curl --request GET \
--url https://api.sortx.co.uk/planned-maintenance/cycles/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/planned-maintenance/cycles/{id}', 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}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, 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>",
"targets": [
{
"programmeId": "<string>",
"propertyId": "<string>",
"blockId": "<string>",
"addressLine": "<string>",
"area": "<string>",
"liveEventId": "<string>",
"nextDueOn": "<string>",
"status": "assign"
}
],
"runs": [
{
"year": 123,
"done": 123,
"total": 123,
"totalCostMinor": 123,
"state": "open",
"open": [
{
"eventId": "<string>",
"addressLine": "<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
Cycle
One cycle with its places and run history by year
GET
/
planned-maintenance
/
cycles
/
{id}
Cycle
curl --request GET \
--url https://api.sortx.co.uk/planned-maintenance/cycles/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/planned-maintenance/cycles/{id}', 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}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, 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>",
"targets": [
{
"programmeId": "<string>",
"propertyId": "<string>",
"blockId": "<string>",
"addressLine": "<string>",
"area": "<string>",
"liveEventId": "<string>",
"nextDueOn": "<string>",
"status": "assign"
}
],
"runs": [
{
"year": 123,
"done": 123,
"total": 123,
"totalCostMinor": 123,
"state": "open",
"open": [
{
"eventId": "<string>",
"addressLine": "<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
Response
Success