Sign in

v1

latestSwagger 2.02026-07-13123.6 KB
MaintenanceController

Create a maintenance job for a specific branch

post/v3/maintenance/{shortName}/maintenance/{branchID}/createmaintenancejob

Path parameters

shortNamestring required

The unique client short-name

branchIDstring required

The unique ID of the Branch

Request body

ExternalIDstring

ID used externally to manage jobs before sending to the system. This has a 10 character limit.

ReportedAtstring date-time

The date the job was reported

IssueTitlestring

The title of the issue

IssueFaultstring

The fault title if applicable

IssueNotesstring

Fault notes

IssuePriority'Low' | 'Medium' | 'High'

The priority of the job (Defaults to 'Low' if incorrect value or empty)

PropertyAddress1string

The first line of the property address

PropertyAddress2string

The second line of the property address

PropertyAddress3string

The third line of the property address

PropertyAddress4string

The forth line of the property address

PropertyPostcodestring

The property postcode

PropertyCountrystring

The country the property is located

TenantTitlestring

The title of the Tenant

TenantForenamestring

The forename of the Tenant

TenantSurnamestring

The surname of the Tenant

TenantEMailAddressstring

The email address of the Tenant

TenantPhonePrimarystring

The primary phone number of the Tenant

TenantPhoneSecondarystring

The secondary phone number of the Tenant

TenantPresenceRequestedboolean

Is the Tenant’s presence requested during the maintenance visit? (Defaults to “false” if incorrect value or empty)

Response

OK

object required
All 1 operations