Create works programme
curl --request POST \
--url https://api.sortx.co.uk/planned-maintenance/works-programmes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"name": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"budgetMinor": 123,
"description": "<string>",
"contractorContactId": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"budgetLineId": "<string>",
"landlordApprovalAboveMinor": 123,
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"jobs": [
{
"propertyId": "<string>",
"title": "<string>",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
name: '<string>',
startsOn: '<string>',
endsOn: '<string>',
budgetMinor: 123,
description: '<string>',
contractorContactId: '<string>',
quotesReceived: 123,
contractorDecisionBy: '<string>',
budgetLineId: '<string>',
landlordApprovalAboveMinor: 123,
followOnCycleId: '<string>',
followOnDueOn: '<string>',
jobs: [
{
propertyId: '<string>',
title: '<string>',
scheduledOn: '<string>',
startMinute: 123,
endMinute: 123,
quoteMinor: 123
}
]
})
};
fetch('https://api.sortx.co.uk/planned-maintenance/works-programmes', 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/works-programmes"
payload = {
"requestId": "<string>",
"name": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"budgetMinor": 123,
"description": "<string>",
"contractorContactId": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"budgetLineId": "<string>",
"landlordApprovalAboveMinor": 123,
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"jobs": [
{
"propertyId": "<string>",
"title": "<string>",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "planning",
"contractorContactId": "<string>",
"contractorName": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"completedOn": "<string>",
"properties": 123,
"propertiesDone": 123,
"budgetMinor": 123,
"spentMinor": 123,
"committedMinor": 123,
"leftMinor": 123,
"awaitingApproval": 123,
"landlordApprovalAboveMinor": 123,
"budgetLineId": "<string>",
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"nextAction": {
"kind": "approval",
"propertyLabel": "<string>",
"amountMinor": 123
},
"nextActionLabel": "<string>",
"revision": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"jobs": [
{
"id": "<string>",
"programmeId": "<string>",
"propertyId": "<string>",
"addressLine": "<string>",
"area": "<string>",
"kind": "works",
"title": "<string>",
"status": "not_booked",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123,
"costMinor": 123,
"approvalState": "required",
"tenantNotifiedAt": "<string>",
"accessRefusedAt": "<string>",
"accessRefusedReason": "<string>",
"completedOn": "<string>",
"budgetLineId": "<string>",
"revision": 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>"
}planned-maintenance
Create works programme
Create a works programme with its properties’ jobs
POST
/
planned-maintenance
/
works-programmes
Create works programme
curl --request POST \
--url https://api.sortx.co.uk/planned-maintenance/works-programmes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"name": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"budgetMinor": 123,
"description": "<string>",
"contractorContactId": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"budgetLineId": "<string>",
"landlordApprovalAboveMinor": 123,
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"jobs": [
{
"propertyId": "<string>",
"title": "<string>",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
name: '<string>',
startsOn: '<string>',
endsOn: '<string>',
budgetMinor: 123,
description: '<string>',
contractorContactId: '<string>',
quotesReceived: 123,
contractorDecisionBy: '<string>',
budgetLineId: '<string>',
landlordApprovalAboveMinor: 123,
followOnCycleId: '<string>',
followOnDueOn: '<string>',
jobs: [
{
propertyId: '<string>',
title: '<string>',
scheduledOn: '<string>',
startMinute: 123,
endMinute: 123,
quoteMinor: 123
}
]
})
};
fetch('https://api.sortx.co.uk/planned-maintenance/works-programmes', 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/works-programmes"
payload = {
"requestId": "<string>",
"name": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"budgetMinor": 123,
"description": "<string>",
"contractorContactId": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"budgetLineId": "<string>",
"landlordApprovalAboveMinor": 123,
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"jobs": [
{
"propertyId": "<string>",
"title": "<string>",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "planning",
"contractorContactId": "<string>",
"contractorName": "<string>",
"quotesReceived": 123,
"contractorDecisionBy": "<string>",
"startsOn": "<string>",
"endsOn": "<string>",
"completedOn": "<string>",
"properties": 123,
"propertiesDone": 123,
"budgetMinor": 123,
"spentMinor": 123,
"committedMinor": 123,
"leftMinor": 123,
"awaitingApproval": 123,
"landlordApprovalAboveMinor": 123,
"budgetLineId": "<string>",
"followOnCycleId": "<string>",
"followOnDueOn": "<string>",
"nextAction": {
"kind": "approval",
"propertyLabel": "<string>",
"amountMinor": 123
},
"nextActionLabel": "<string>",
"revision": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"jobs": [
{
"id": "<string>",
"programmeId": "<string>",
"propertyId": "<string>",
"addressLine": "<string>",
"area": "<string>",
"kind": "works",
"title": "<string>",
"status": "not_booked",
"scheduledOn": "<string>",
"startMinute": 123,
"endMinute": 123,
"quoteMinor": 123,
"costMinor": 123,
"approvalState": "required",
"tenantNotifiedAt": "<string>",
"accessRefusedAt": "<string>",
"accessRefusedReason": "<string>",
"completedOn": "<string>",
"budgetLineId": "<string>",
"revision": 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
Response
Success