{"swagger":"2.0","info":{"version":"v4-maintenance","title":"agentOS API V4, Maintenance Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/maintenance/{shortname}/{branchID}/tenancies/tenancyState/{offset}/{count}":{"get":{"tags":["TenancyController"],"summary":"Retrieves all tenancies and their states by BranchID. Includes Archived Tenancys","operationId":"TenancyController_GetTenancyStateByBranch","consumes":[],"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 branch to retrieve properties from","required":true,"type":"string"},{"name":"offset","in":"path","description":"&gt;The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TenancyModelResults"}}}}},"/v4/maintenance/{shortName}/company/branches/{branchID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific branch given its unique Object ID (OID):-","operationId":"CompanyController_GetBranches","consumes":[],"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"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModel"}}}}},"/v4/maintenance/{shortName}/company/branches/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All branches defined for a company:-","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModelResults"}}}}},"/v4/maintenance/{shortName}/company/object/{objectID}/customfield":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field by ObjectID:-","operationId":"CompanyController_GetCustomfieldbyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCustomField"}}}}},"/v4/maintenance/{shortName}/company/objects/{objectID}/{fieldID}/customfield":{"post":{"tags":["CompanyController"],"summary":"Set Custom Field Value:-","operationId":"CompanyController_SetCustomFieldValue","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":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"},{"name":"value","in":"body","description":"Value to enter (string)","required":true,"schema":{"$ref":"#/definitions/BaseCustomFieldSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/maintenance/{shortName}/company/objects/{objectID}/{fieldID}/value":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field Value:-","operationId":"CompanyController_GetCustomFieldValue","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/maintenance/{shortName}/contacts/contractors/{branchID}/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Get all Contractors for a specified branch:-","operationId":"ContactsController_GetContractorsByBranch","consumes":[],"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 ID of the branch to retrieve Contractors from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContractorModelResults"}}}}},"/v4/maintenance/{shortName}/contacts/contractors/{contractorID}":{"get":{"tags":["ContactsController"],"summary":"Get Contractor from a specified ID:-","operationId":"ContactsController_GetContractorByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"contractorID","in":"path","description":"The ID of the Contractor to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContractorModel"}}}}},"/v4/maintenance/{shortName}/contacts/landlords/{branchID}/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Get all landlords for a specified branch:-","operationId":"ContactsController_GetLandlordsByBranch","consumes":[],"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 ID of the branch to retrieve landlords from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LandlordModelResults"}}}}},"/v4/maintenance/{shortName}/contacts/landlords/{landlordID}":{"get":{"tags":["ContactsController"],"summary":"Get landlord from a specified ID:-","operationId":"ContactsController_GetLandlordByIDMaintenance","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"landlordID","in":"path","description":"The ID of the landlord to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LandlordModel"}}}}},"/v4/maintenance/{shortName}/contacts/staff/{staffMemberID}":{"get":{"tags":["ContactsController"],"summary":"Get staff member from a specified ID:-","operationId":"ContactsController_GetStaffMemberByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"staffID","in":"query","description":"The ID of the property to retrieve","required":true,"type":"string"},{"name":"staffMemberID","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseStaffMemberModel"}}}}},"/v4/maintenance/{shortName}/contacts/tenants/{branchID}/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Get all tenants for a specified branch:-","operationId":"ContactsController_GetTenantsFromBranch","consumes":[],"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 ID of the branch to retrieve tenants from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TenantModelResults"}}}}},"/v4/maintenance/{shortName}/contacts/tenants/{tenantID}":{"get":{"tags":["ContactsController"],"summary":"Get tenant from a specified ID:-","operationId":"ContactsController_GetTenantByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"tenantID","in":"path","description":"The ID of the tenant to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TenantModel"}}}}},"/v4/maintenance/{shortName}/invoice/submit":{"post":{"tags":["InvoiceController"],"summary":"Submit new invoice.","operationId":"InvoiceController_CreateInvoice","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":"submissionModel","in":"body","description":"Data for invoice to create","required":true,"schema":{"$ref":"#/definitions/ContractorInvoiceSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/maintenance/{shortName}/jobs/{branchID}/{offset}/{count}":{"get":{"tags":["JobsController"],"summary":"All maintenance jobs for the specified branch:-","operationId":"JobsController_GetJobs","consumes":[],"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 branch to retrieve maintenance jobs from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"},{"name":"modifiedSince","in":"query","description":"Optional. ISO-8601 UTC date/time; only jobs changed on or after this are returned. Ideal for incremental sync.","required":false,"type":"string","format":"date-time"},{"name":"modifiedUntil","in":"query","description":"Optional. ISO-8601 UTC date/time; only jobs changed on or before this are returned.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceJobModelResults"}}}}},"/v4/maintenance/{shortName}/jobs/{branchID}/job":{"post":{"tags":["JobsController"],"summary":"Create a maintenance job for a specific branch","operationId":"JobsController_CreateJob","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":"Branch to create job on","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Job Submission Model","required":true,"schema":{"$ref":"#/definitions/MaintenanceJobSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/maintenance/{shortName}/jobs/{jobID}":{"get":{"tags":["JobsController"],"summary":"Get maintenance job from a specified ID:-","operationId":"JobsController_GetJob","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"jobID","in":"path","description":"The ID of the job to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceJobModel"}}}},"patch":{"tags":["JobsController"],"summary":"Update maintenance job:-","operationId":"JobsController_UpdateJob","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":"jobID","in":"path","description":"The ID of the job to update","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"The details of the maintenance job to update:-","required":true,"schema":{"$ref":"#/definitions/MaintenanceJobSubmissionModel"}},{"name":"noContractor","in":"query","description":"Remove Contractor:-","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/maintenance/{shortName}/jobs/{jobID}/attachdocument":{"post":{"tags":["JobsController"],"summary":"Attach a document to a maintenance job:-","operationId":"JobsController_AttachDocumentToMaintenanceJob","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":"jobID","in":"path","description":"The unique ID of the job to attach document to","required":true,"type":"string"},{"name":"document","in":"body","description":"Document to link","required":true,"schema":{"$ref":"#/definitions/BaseInternalDocumentSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/maintenance/{shortName}/jobs/statusTypes/{offset}/{count}":{"get":{"tags":["JobsController"],"summary":"All maintenance job status types:-","operationId":"JobsController_GetStatusTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceJobStatusTypeModelResults"}}}}},"/v4/maintenance/{shortName}/jobs/statustypes/{statusID}":{"get":{"tags":["JobsController"],"summary":"Get maintenance job status type from a specified ID:-","operationId":"JobsController_GetJobStatusType","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"statusID","in":"path","description":"The ID of the status to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenanceJobStatusTypeModel"}}}}},"/v4/maintenance/{shortName}/preferences/{preferenceID}":{"get":{"tags":["PreferencesController"],"summary":"Get maintenance preference from a specified ID:-","operationId":"PreferencesController_GetPreference","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"preferenceID","in":"path","description":"The ID of the preference to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenancePreferenceModel"}}}}},"/v4/maintenance/{shortName}/preferences/{propertyID}/{offset}/{count}":{"get":{"tags":["PreferencesController"],"summary":"All maintenance preferences for the specified property:-","operationId":"PreferencesController_GetPreferences","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The property to retrieve maintenance preferences from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaintenancePreferenceModelResults"}}}}},"/v4/maintenance/{shortName}/properties/{branchID}/{offset}/{count}":{"get":{"tags":["PropertyController"],"summary":"All properties for the specified branch (including archived properties):-\r\nNote: Archived properties are included for integrator compatibility. Use the ManagedMaintenance property to filter for maintenance-managed properties if needed.","operationId":"PropertyController_GetProperties","consumes":[],"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 branch to retrieve properties from","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FixfloPropertyModelResults"}}}}},"/v4/maintenance/{shortName}/properties/{propertyID}":{"get":{"tags":["PropertyController"],"summary":"Get property from a specified ID:-","operationId":"PropertyController_GetPropertyByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The ID of the property to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FixfloPropertyModel"}}}}}},"definitions":{"BaseBranchModelResults":{"description":"Holds results from a paged query returning BranchModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/BaseBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModel":{"description":"Defines a single branch of a client.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The branch name.","type":"string"},"CompanyName":{"description":"The relevant company name, if not the one specified on the branch then the one on company.","type":"string"},"Address1":{"description":"Branch address line 1.","type":"string"},"Address2":{"description":"Branch address line 2.","type":"string"},"Address3":{"description":"Branch address line 3.","type":"string"},"Address4":{"description":"Branch address line 4.","type":"string"},"Postcode":{"description":"Branch address postcode.","type":"string"},"WebAddress":{"description":"Branch web address.","type":"string"},"EMailAddress":{"description":"Branch email address.","type":"string"},"LandPhone":{"description":"Branch land phone number.","type":"string"},"FaxPhone":{"description":"Branch fax phone number.","type":"string"},"County":{"description":"County","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseHypermediaLink":{"description":"Hypermedia Link Class","type":"object","properties":{"Relationship":{"description":"The hypermedia link relationship to current result object.","type":"string"},"Href":{"description":"The hypermedia href","type":"string"},"Method":{"description":"The http method type","type":"string"}}},"BaseCustomField":{"type":"object","properties":{"CustomFields":{"description":"Dynamic Custom Field:-","type":"array","items":{"$ref":"#/definitions/CustomFieldDataModel"}}}},"CustomFieldDataModel":{"type":"object","properties":{"ID":{"description":"Field ID:-","type":"string"},"TabName":{"description":"Tab on OS custom field belongs to:-","type":"string"},"GroupName":{"description":"The grouping on OS the custom field belongs to:-","type":"string"},"FieldName":{"description":"Name of the custom field:-","type":"string"},"Retired":{"description":"Is field retired:-","type":"boolean"},"Value":{"description":"Custom Field Value:-","type":"object"}}},"BaseCustomFieldSubmissionModel":{"type":"object","properties":{"customfieldValue":{"description":"Custom Field Value","type":"string"}}},"BaseStaffMemberModel":{"description":"Base Staff Member Model","type":"object","properties":{"OID":{"description":"Staff Member ID:-","type":"string"},"GlobalReference":{"description":"Staff member global reference:-","type":"string"},"Name":{"description":"Staff Member name:-","type":"string"},"JobTitle":{"description":"Staff member job title:-","type":"string"},"OwnedByBranch":{"description":"Owned By Branch:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"LandlordModel":{"description":"Maintenance Landlord Model:-","type":"object","properties":{"PropertyIDs":{"description":"Array of Property IDs that the landlord owns:-","type":"array","items":{"type":"string"}},"OID":{"description":"Unique Person ID:-","type":"string"},"GlobalReference":{"description":"User friendly unique person ID:-","type":"string"},"ETag":{"description":"Person ETag:-","type":"string","readOnly":true},"Title":{"description":"Person's Title:-","type":"string"},"Forename":{"description":"Person's Forename:-","type":"string"},"Surname":{"description":"Person's Surname:-","type":"string"},"EmailAddress":{"description":"Email Address:-","type":"string"},"MobileNumber":{"description":"Mobile Number:-","type":"string"},"Landline":{"description":"Landline Number:-","type":"string"},"IsArchived":{"description":"Is Archived","type":"boolean","readOnly":true},"AssignedAgentID":{"description":"The ID of the agent assigned to the person:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"LandlordModelResults":{"description":"Landlord Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/LandlordModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"TenantModel":{"description":"Maintenance Tenant Model:-","type":"object","properties":{"PropertyID":{"description":"Property ID of latest tenancy tenant is linked to:-","type":"string"},"TenancyOID":{"description":"The Unique Tenancy ID:-","type":"string","readOnly":true},"OID":{"description":"Unique Person ID:-","type":"string"},"GlobalReference":{"description":"User friendly unique person ID:-","type":"string"},"ETag":{"description":"Person ETag:-","type":"string","readOnly":true},"Title":{"description":"Person's Title:-","type":"string"},"Forename":{"description":"Person's Forename:-","type":"string"},"Surname":{"description":"Person's Surname:-","type":"string"},"EmailAddress":{"description":"Email Address:-","type":"string"},"MobileNumber":{"description":"Mobile Number:-","type":"string"},"Landline":{"description":"Landline Number:-","type":"string"},"IsArchived":{"description":"Is Archived","type":"boolean","readOnly":true},"AssignedAgentID":{"description":"The ID of the agent assigned to the person:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"TenantModelResults":{"description":"Tenant Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/TenantModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ContractorModel":{"description":"Maintenance Contractor Model:-","type":"object","properties":{"PersonRecords":{"$ref":"#/definitions/BaseMaintenancePersonRecordModel","description":"BaseMaintenancePersonRecordModel Helper:-","readOnly":true},"CompanyName":{"description":"Company Name","type":"string"},"Links":{"description":"Base Media Hyperlink","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"},"readOnly":true}}},"BaseMaintenancePersonRecordModel":{"description":"Base Person Record for V4 Maintenance Tier:-","type":"object","properties":{"OID":{"description":"Unique Person ID:-","type":"string"},"GlobalReference":{"description":"User friendly unique person ID:-","type":"string"},"ETag":{"description":"Person ETag:-","type":"string","readOnly":true},"Title":{"description":"Person's Title:-","type":"string"},"Forename":{"description":"Person's Forename:-","type":"string"},"Surname":{"description":"Person's Surname:-","type":"string"},"EmailAddress":{"description":"Email Address:-","type":"string"},"MobileNumber":{"description":"Mobile Number:-","type":"string"},"Landline":{"description":"Landline Number:-","type":"string"},"IsArchived":{"description":"Is Archived","type":"boolean","readOnly":true},"AssignedAgentID":{"description":"The ID of the agent assigned to the person:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ContractorModelResults":{"description":"Contractor Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ContractorModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ContractorInvoiceSubmissionModel":{"description":"Contractor Invoice Submission Model:-","type":"object","properties":{"JobID":{"description":"Maintenance Job ID:-","type":"string"},"ContractorID":{"description":"Contractor ID:-","type":"string"},"AmountToInvoice":{"format":"double","description":"Amount to Invoice:-","type":"number"},"SupportingDocuments":{"description":"Supporting Documents To Upload:-","type":"array","items":{"$ref":"#/definitions/BaseInternalDocumentSubmissionModel"}},"Description":{"description":"Description of invoice:-","type":"string"}}},"BaseInternalDocumentSubmissionModel":{"description":"Base Document Submission Model:-","type":"object","properties":{"DocumentName":{"description":"The document to create name:-","type":"string"},"MimeType":{"description":"The document to create's MIME type:-","type":"string"},"Content":{"description":"The document to create's content:-","type":"string"}}},"MaintenanceJobModelResults":{"description":"Maintenance Job Model Results:-","type":"object","properties":{"Data":{"description":"Data:-","type":"array","items":{"$ref":"#/definitions/MaintenanceJobModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"MaintenanceJobModel":{"description":"Maintenance Job Model:-","type":"object","properties":{"OID":{"description":"Unique Job ID:-","type":"string"},"GlobalReference":{"description":"Job Global Reference:-","type":"string","readOnly":true},"ETag":{"description":"Job ETag:-","type":"string","readOnly":true},"BranchID":{"description":"BranchID","type":"string"},"FaultDescription":{"description":"Fault Description:-","type":"string"},"StatusID":{"description":"Status:-","type":"string"},"CreatedAt":{"format":"date-time","description":"Created At:-","type":"string"},"IsArchived":{"description":"Is Archived","type":"boolean"},"ContractorID":{"description":"Contractor ID:-","type":"string"},"Priority":{"description":"Maintenance Priority:-","enum":["Low","Medium","High"],"type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"MaintenanceJobSubmissionModel":{"description":"Maintenance Job Submission Model:-","type":"object","properties":{"FaultDescription":{"description":"Fault Description:-","type":"string"},"StatusID":{"description":"Status:-","type":"string"},"CreatedAt":{"format":"date-time","description":"Created At:-","type":"string"},"ContractorID":{"description":"Contractor ID:-","type":"string"},"Priority":{"description":"Maintenance Priority:-","enum":["Low","Medium","High"],"type":"string"},"PropertyID":{"description":"Property ID:-","type":"string"}}},"MaintenanceJobStatusTypeModelResults":{"description":"Maintenance Job Status Type Model Results:-","type":"object","properties":{"Data":{"description":"Data:-","type":"array","items":{"$ref":"#/definitions/MaintenanceJobStatusTypeModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"MaintenanceJobStatusTypeModel":{"description":"Maintenance Job Status Type Model:-","type":"object","properties":{"OID":{"description":"The unique status ID:-","type":"string"},"ETag":{"description":"Maintenance Job Status ETag:-","type":"string","readOnly":true},"Name":{"description":"The status name:-","type":"string"},"State":{"description":"State the job status places the maintenance job in (\"Reported\" = System reported statuses, \"Actioned\" = System Actioned Statuses, \"Closed\" = System Closed Statuses, \"Custom\" = Client created status:-","enum":["Reported","Actioned","Closed","Custom"],"type":"string"}}},"MaintenancePreferenceModelResults":{"description":"Maintenance Preference Model Results:-","type":"object","properties":{"Data":{"description":"Data:-","type":"array","items":{"$ref":"#/definitions/MaintenancePreferenceModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"MaintenancePreferenceModel":{"description":"Maintenance Preference Model:-","type":"object","properties":{"OID":{"description":"Unique Preference ID:-","type":"string"},"ETag":{"description":"Preference ETag:-","type":"string","readOnly":true},"PropertyID":{"description":"Property ID:-","type":"string"},"Name":{"description":"Preference Name:-","type":"string"},"Notes":{"description":"Preference Notes:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"FixfloPropertyModelResults":{"description":"Fixflo Maintenance Property Model Results","type":"object","properties":{"Data":{"description":"Data:-","type":"array","items":{"$ref":"#/definitions/FixfloPropertyModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"FixfloPropertyModel":{"description":"Fixflo Maintenance Property Model","type":"object","properties":{"OID":{"description":"The property's unique ID:-","type":"string"},"GlobalReference":{"description":"User friendly unique ID for the property:-","type":"string"},"ETag":{"description":"Property ETag:-","type":"string","readOnly":true},"BranchID":{"description":"Branch ID of the managing branch:-","type":"string"},"IsArchived":{"description":"Is Archived.","type":"boolean","readOnly":true},"StaffMemberID":{"description":"The unique ID of the managing staff member if one is set:-","type":"string"},"Address":{"$ref":"#/definitions/BaseAddressModel","description":"The property's address:-"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}},"ManagedMaintenance":{"description":"Does the agent manage maintenance for the property?","type":"boolean","readOnly":true},"SecurityNotes":{"description":"The Properties Security Notes:-","type":"string","readOnly":true}}},"BaseAddressModel":{"description":"Base Address Model:-","type":"object","properties":{"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address 2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Postcode:-","type":"string"},"FlatOrRoomNumber":{"description":"Flat Or Room Number:-","type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"}}},"TenancyModelResults":{"description":"Tenancy Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/TenancyModel"}},"Count":{"format":"int32","description":"Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"TenancyModel":{"description":"Maintenance Tenancy Model:-","type":"object","properties":{"OID":{"description":"The Tenancys unique ID:-","type":"string","readOnly":true},"PropertyOID":{"description":"The properties unique ID:-","type":"string","readOnly":true},"IsTenancyAdvertised":{"description":"Is Tenancy Advertised:-","type":"boolean","readOnly":true},"IsTenancyProposed":{"description":"Is Tenancy Proposed:-","type":"boolean","readOnly":true},"IsTenanySigned":{"description":"Is Tenancy Signed:-","type":"boolean","readOnly":true},"IsTenancyEnded":{"description":"Is Tenancy Ended:-","type":"boolean","readOnly":true},"IsTenancyClosed":{"description":"Is Tenancy Closed:-","type":"boolean","readOnly":true},"IsTenancyAbandoned":{"description":"Is Tenancy Abandoned:-","type":"boolean","readOnly":true},"IsArchived":{"description":"Is Object Archived:-","type":"boolean","readOnly":true},"TenantOID":{"description":"Tenants Maintenance Model:-","type":"array","items":{"$ref":"#/definitions/TenantsMaintenanceModel"},"readOnly":true}}},"TenantsMaintenanceModel":{"description":"Tenants Maintenance Model Helper Class","type":"object","properties":{"OID":{"description":"The Tenants unique ID:-","type":"string","readOnly":true}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}