Sign off work order
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/work-orders/{id}/sign-off \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"rating": 123
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', rating: 123})
};
fetch('https://api.sortx.co.uk/maintenance-pro/work-orders/{id}/sign-off', 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/work-orders/{id}/sign-off"
payload = {
"requestId": "<string>",
"rating": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"order": {
"id": "<string>",
"repairId": "<string>",
"reference": "<string>",
"repairReference": "<string>",
"origin": "assignment",
"jobId": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"scope": "<string>",
"note": "<string>",
"makeSafe": true,
"status": "draft",
"value": {
"amountMinor": 123,
"currency": "<string>",
"basis": "quote"
},
"quoteId": "<string>",
"calendarEventId": "<string>",
"scheduledFor": "<string>",
"access": "keys_from_office",
"sentAt": "<string>",
"acceptedAt": "<string>",
"onSiteAt": "<string>",
"doneAt": "<string>",
"cancelledAt": "<string>",
"cancelReason": "<string>",
"signedOffAt": "<string>",
"priority": "emergency",
"awaitingLandlord": true,
"sentBackAt": "<string>",
"pendingExtra": {
"quoteId": "<string>",
"amountMinor": 123,
"notes": "<string>"
}
},
"priority": "emergency",
"tenantNote": "<string>",
"version": 123,
"awaitingLandlord": true,
"signOffRating": 123,
"sentBack": {
"at": "<string>",
"reasons": [
"<string>"
],
"note": "<string>",
"revisitBy": "<string>"
},
"cancelFeeMinor": 123,
"completion": {
"at": "<string>",
"workDone": "<string>",
"photos": [
{
"documentId": "<string>",
"stage": "<string>",
"label": "<string>"
}
],
"certificate": true
},
"extras": [
{
"quoteId": "<string>",
"amountMinor": 123,
"notes": "<string>",
"receivedAt": "<string>",
"decision": "approved",
"decidedAt": "<string>"
}
],
"versions": [
{
"version": 123,
"changes": [
"<string>"
],
"scope": "<string>",
"valueMinor": 123,
"visit": "<string>",
"access": "<string>",
"reason": "<string>",
"needsLandlord": true,
"createdAt": "<string>"
}
],
"attempts": [
{
"id": "<string>",
"visitAt": "<string>",
"outcome": "no_access",
"counts": true,
"chargeMinor": 123,
"chargeDecision": "pay",
"slots": [
"<string>"
],
"createdAt": "<string>"
}
],
"updates": [
{
"at": "<string>",
"title": "<string>",
"detail": "<string>",
"tone": "a"
}
]
}{
"_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
Sign off work order
Sign off a done work order, rating the contractor; the last one on a repair moves it to Fixed
POST
/
maintenance-pro
/
work-orders
/
{id}
/
sign-off
Sign off work order
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/work-orders/{id}/sign-off \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"rating": 123
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({requestId: '<string>', rating: 123})
};
fetch('https://api.sortx.co.uk/maintenance-pro/work-orders/{id}/sign-off', 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/work-orders/{id}/sign-off"
payload = {
"requestId": "<string>",
"rating": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"order": {
"id": "<string>",
"repairId": "<string>",
"reference": "<string>",
"repairReference": "<string>",
"origin": "assignment",
"jobId": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"scope": "<string>",
"note": "<string>",
"makeSafe": true,
"status": "draft",
"value": {
"amountMinor": 123,
"currency": "<string>",
"basis": "quote"
},
"quoteId": "<string>",
"calendarEventId": "<string>",
"scheduledFor": "<string>",
"access": "keys_from_office",
"sentAt": "<string>",
"acceptedAt": "<string>",
"onSiteAt": "<string>",
"doneAt": "<string>",
"cancelledAt": "<string>",
"cancelReason": "<string>",
"signedOffAt": "<string>",
"priority": "emergency",
"awaitingLandlord": true,
"sentBackAt": "<string>",
"pendingExtra": {
"quoteId": "<string>",
"amountMinor": 123,
"notes": "<string>"
}
},
"priority": "emergency",
"tenantNote": "<string>",
"version": 123,
"awaitingLandlord": true,
"signOffRating": 123,
"sentBack": {
"at": "<string>",
"reasons": [
"<string>"
],
"note": "<string>",
"revisitBy": "<string>"
},
"cancelFeeMinor": 123,
"completion": {
"at": "<string>",
"workDone": "<string>",
"photos": [
{
"documentId": "<string>",
"stage": "<string>",
"label": "<string>"
}
],
"certificate": true
},
"extras": [
{
"quoteId": "<string>",
"amountMinor": 123,
"notes": "<string>",
"receivedAt": "<string>",
"decision": "approved",
"decidedAt": "<string>"
}
],
"versions": [
{
"version": 123,
"changes": [
"<string>"
],
"scope": "<string>",
"valueMinor": 123,
"visit": "<string>",
"access": "<string>",
"reason": "<string>",
"needsLandlord": true,
"createdAt": "<string>"
}
],
"attempts": [
{
"id": "<string>",
"visitAt": "<string>",
"outcome": "no_access",
"counts": true,
"chargeMinor": 123,
"chargeDecision": "pay",
"slots": [
"<string>"
],
"createdAt": "<string>"
}
],
"updates": [
{
"at": "<string>",
"title": "<string>",
"detail": "<string>",
"tone": "a"
}
]
}{
"_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