Log safety check
curl --request POST \
--url https://api.sortx.co.uk/compliance/safety-checks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"subjectId": "<string>",
"unitId": "<string>",
"checkedOn": "<string>",
"note": "<string>",
"documentId": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
subjectId: '<string>',
unitId: '<string>',
checkedOn: '<string>',
note: '<string>',
documentId: '<string>'
})
};
fetch('https://api.sortx.co.uk/compliance/safety-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/safety-checks"
payload = {
"requestId": "<string>",
"subjectId": "<string>",
"unitId": "<string>",
"checkedOn": "<string>",
"note": "<string>",
"documentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"subjectKind": "property",
"subjectId": "<string>",
"unitId": "<string>",
"kind": "fire_alarm_test",
"checkedOn": "<string>",
"outcome": "pass",
"note": "<string>",
"documentId": "<string>",
"loggedAt": "<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>"
}compliance
Log safety check
Log a routine fire safety check (alarm test, fire doors, emergency lighting, equipment)
POST
/
compliance
/
safety-checks
Log safety check
curl --request POST \
--url https://api.sortx.co.uk/compliance/safety-checks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"subjectId": "<string>",
"unitId": "<string>",
"checkedOn": "<string>",
"note": "<string>",
"documentId": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
subjectId: '<string>',
unitId: '<string>',
checkedOn: '<string>',
note: '<string>',
documentId: '<string>'
})
};
fetch('https://api.sortx.co.uk/compliance/safety-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/safety-checks"
payload = {
"requestId": "<string>",
"subjectId": "<string>",
"unitId": "<string>",
"checkedOn": "<string>",
"note": "<string>",
"documentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"subjectKind": "property",
"subjectId": "<string>",
"unitId": "<string>",
"kind": "fire_alarm_test",
"checkedOn": "<string>",
"outcome": "pass",
"note": "<string>",
"documentId": "<string>",
"loggedAt": "<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