Book repair job visit
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/repairs/{id}/jobs/{jobId}/book \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"startsAt": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', expectedRevision: 123, startsAt: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/repairs/{id}/jobs/{jobId}/book', 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/repairs/{id}/jobs/{jobId}/book"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"startsAt": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"repairId": "<string>",
"mainPartDone": true,
"openJobs": 123,
"jobs": [
{
"id": "<string>",
"position": 123,
"trade": "<string>",
"tradeLabel": "<string>",
"scope": "<string>",
"order": "parallel",
"status": "open",
"contractorContactId": "<string>",
"contractor": "<string>",
"scheduledFor": "<string>",
"calendarEventId": "<string>",
"cancelReason": "<string>",
"revision": 123,
"visits": [
{
"calendarEventId": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"state": "booked",
"current": true,
"outcome": {
"result": "fixed",
"reasons": [
"tenant_not_home"
],
"note": "<string>",
"source": "staff",
"recordedAt": "<string>"
}
}
],
"createdAt": "<string>"
}
],
"series": [
{
"id": "<string>",
"visits": [
{
"calendarEventId": "<string>",
"position": 123,
"total": 123,
"purpose": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"state": "booked",
"current": true
}
],
"createdAt": "<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
Book repair job visit
Book (or move) a second job’s visit
POST
/
maintenance-pro
/
repairs
/
{id}
/
jobs
/
{jobId}
/
book
Book repair job visit
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/repairs/{id}/jobs/{jobId}/book \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"startsAt": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', expectedRevision: 123, startsAt: '<string>'})
};
fetch('https://api.sortx.co.uk/maintenance-pro/repairs/{id}/jobs/{jobId}/book', 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/repairs/{id}/jobs/{jobId}/book"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"startsAt": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"repairId": "<string>",
"mainPartDone": true,
"openJobs": 123,
"jobs": [
{
"id": "<string>",
"position": 123,
"trade": "<string>",
"tradeLabel": "<string>",
"scope": "<string>",
"order": "parallel",
"status": "open",
"contractorContactId": "<string>",
"contractor": "<string>",
"scheduledFor": "<string>",
"calendarEventId": "<string>",
"cancelReason": "<string>",
"revision": 123,
"visits": [
{
"calendarEventId": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"state": "booked",
"current": true,
"outcome": {
"result": "fixed",
"reasons": [
"tenant_not_home"
],
"note": "<string>",
"source": "staff",
"recordedAt": "<string>"
}
}
],
"createdAt": "<string>"
}
],
"series": [
{
"id": "<string>",
"visits": [
{
"calendarEventId": "<string>",
"position": 123,
"total": 123,
"purpose": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"state": "booked",
"current": true
}
],
"createdAt": "<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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Body
application/json