Set cycle rules
curl --request PUT \
--url https://api.sortx.co.uk/inspections/cycle-rules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"defaultMonths": 123,
"byKind": [
{
"kind": "<string>",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"months": 123
}
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
defaultMonths: 123,
byKind: [{kind: '<string>', months: 123}],
byProperty: [{propertyId: '<string>', months: 123}]
})
};
fetch('https://api.sortx.co.uk/inspections/cycle-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/inspections/cycle-rules"
payload = {
"defaultMonths": 123,
"byKind": [
{
"kind": "<string>",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"months": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"defaultMonths": 123,
"byKind": [
{
"kind": "hmo",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"propertyLabel": "<string>",
"months": 123
}
]
}{
"_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>"
}inspections
Set cycle rules
Replace the routine cycle rules: the default, per kind and per property
PUT
/
inspections
/
cycle-rules
Set cycle rules
curl --request PUT \
--url https://api.sortx.co.uk/inspections/cycle-rules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"defaultMonths": 123,
"byKind": [
{
"kind": "<string>",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"months": 123
}
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
defaultMonths: 123,
byKind: [{kind: '<string>', months: 123}],
byProperty: [{propertyId: '<string>', months: 123}]
})
};
fetch('https://api.sortx.co.uk/inspections/cycle-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/inspections/cycle-rules"
payload = {
"defaultMonths": 123,
"byKind": [
{
"kind": "<string>",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"months": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"defaultMonths": 123,
"byKind": [
{
"kind": "hmo",
"months": 123
}
],
"byProperty": [
{
"propertyId": "<string>",
"propertyLabel": "<string>",
"months": 123
}
]
}{
"_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