{"swagger":"2.0","info":{"version":"v3-maintenance","title":"agentOS API V3, Maintenance Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v3/maintenance/{shortName}/maintenance/{branchID}/createmaintenancejob":{"post":{"tags":["MaintenanceController"],"summary":"Create a maintenance job for a specific branch","operationId":"MaintenanceController_CreateMaintenanceJob","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"issue","in":"body","description":"A JSON object containing details of the maintenance job","required":true,"schema":{"$ref":"#/definitions/MaintenanceIssueModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}}},"definitions":{"MaintenanceIssueModel":{"description":"Submission Model - Handles all fields required to submit an online maintenance job","type":"object","properties":{"ExternalID":{"description":"ID used externally to manage jobs before sending to the system. This has a 10 character limit.","type":"string"},"ReportedAt":{"format":"date-time","description":"The date the job was reported","type":"string"},"IssueTitle":{"description":"The title of the issue","type":"string"},"IssueFault":{"description":"The fault title if applicable","type":"string"},"IssueNotes":{"description":"Fault notes","type":"string"},"IssuePriority":{"description":"The priority of the job (Defaults to 'Low' if incorrect value or empty)","enum":["Low","Medium","High"],"type":"string"},"PropertyAddress1":{"description":"The first line of the property address","type":"string"},"PropertyAddress2":{"description":"The second line of the property address","type":"string"},"PropertyAddress3":{"description":"The third line of the property address","type":"string"},"PropertyAddress4":{"description":"The forth line of the property address","type":"string"},"PropertyPostcode":{"description":"The property postcode","type":"string"},"PropertyCountry":{"description":"The country the property is located","type":"string"},"TenantTitle":{"description":"The title of the Tenant","type":"string"},"TenantForename":{"description":"The forename of the Tenant","type":"string"},"TenantSurname":{"description":"The surname of the Tenant","type":"string"},"TenantEMailAddress":{"description":"The email address of the Tenant","type":"string"},"TenantPhonePrimary":{"description":"The primary phone number of the Tenant","type":"string"},"TenantPhoneSecondary":{"description":"The secondary phone number of the Tenant","type":"string"},"TenantPresenceRequested":{"description":"Is the Tenant’s presence requested during the maintenance visit? (Defaults to “false” if incorrect value or empty)","type":"boolean"},"Documents":{"description":"Documents linked to a submitted maintenance job","type":"array","items":{"$ref":"#/definitions/MaintenanceDocumentModel"}}}},"MaintenanceDocumentModel":{"description":"Submission Model - Handles all the fields required to attach documents to an online maintenance job","type":"object","properties":{"MimeType":{"description":"The document Mime Type","type":"string"},"URL":{"description":"The document URL (This has to be public)","type":"string"}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}