{"swagger":"2.0","info":{"version":"v4-inspections","title":"agentOS API V4, Inspections Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/inspections/{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/inspections/{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/inspections/{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/inspections/{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/inspections/{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/inspections/{shortName}/contacts/landlords/{landlordID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve landlord associated with the landlord ID:-","operationId":"ContactsController_GetLandlordByID","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 unique landlord ID","required":true,"type":"string"},{"name":"integrator","in":"query","description":"integrator(optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionContactModel"}}}}},"/v4/inspections/{shortName}/contacts/staff/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Retrieve all staff members for a branch:-","operationId":"ContactsController_GetStaffMembers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The unique branch ID","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":"Number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsStaffModelResults"}}}}},"/v4/inspections/{shortName}/contacts/staff/{staffID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve staff member associated with a staff 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":"path","description":"The unique staff ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsStaffModel"}}}}},"/v4/inspections/{shortName}/contacts/tenants/{tenantID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve tenant associated with the tenant 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 unique tenant ID","required":true,"type":"string"},{"name":"integrator","in":"query","description":"integrator(optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionTenantContactModel"}}}}},"/v4/inspections/{shortName}/diary/appointments/{appointmentID}":{"get":{"tags":["DiaryController"],"summary":"Retrieve an appointment by it's unique ID:-","operationId":"DiaryController_GetAppointmentByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"appointmentID","in":"path","description":"The unique appointment ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsDiaryAppointmentModel"}}}}},"/v4/inspections/{shortName}/diary/appointments/{offset}/{count}":{"get":{"tags":["DiaryController"],"summary":"Retrieve all appointments between two dates, or recur between two dates:-","operationId":"DiaryController_GetAppointmentsBetweenDates","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The branch to retrieve appointments for","required":true,"type":"string"},{"name":"appointmentTypesToSearch","in":"query","description":"The appointment types to search","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startDate","in":"query","description":"The date to commence the search from","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The date to search until","required":true,"type":"string","format":"date-time"},{"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/InspectionsDiaryAppointmentModelResults"}}}}},"/v4/inspections/{shortName}/diary/appointmenttypes/{appointmentTypeID}":{"get":{"tags":["DiaryController"],"summary":"Retrieve appointment type by ID:-","operationId":"DiaryController_GetAppointmentTypeByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"appointmentTypeID","in":"path","description":"The unique appointment type ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsDiaryAppointmentTypesModel"}}}}},"/v4/inspections/{shortName}/diary/appointmenttypes/{offset}/{count}":{"get":{"tags":["DiaryController"],"summary":"Retrieve all appointment types set up in the system:-","operationId":"DiaryController_GetAppointmentTypes","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 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/InspectionsDiaryAppointmentTypesModelResults"}}}}},"/v4/inspections/{shortName}/documents/property/add":{"post":{"tags":["DocumentsController"],"summary":"Add a document to a property's \"Saved Documents\" section","description":"If the document is over 10mb in size it will be added as an external document.","operationId":"DocumentsController_AddPropertyDocument","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":"propertyID","in":"query","description":"The unique property ID.","required":true,"type":"string"},{"name":"document","in":"body","description":"The document to add","required":true,"schema":{"$ref":"#/definitions/BaseDocumentSubmissionModel"}},{"name":"landlordID","in":"query","description":"The landlord to add to a document","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/inspections/{shortName}/documents/tenancy/add":{"post":{"tags":["DocumentsController"],"summary":"Add a document to a tenancies \"Saved Documents\" section","description":"If the document is over 10mb in size it will be added as an external document.","operationId":"DocumentsController_AddTenancyDocument","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":"tenancyID","in":"query","description":"The unique tenancy ID.","required":true,"type":"string"},{"name":"document","in":"body","description":"The document to add","required":true,"schema":{"$ref":"#/definitions/BaseDocumentSubmissionModel"}},{"name":"landlordID","in":"query","description":"The landlord to add to a document","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/V4/inspections/{shortName}/properties/{branchID}/{offset}/{count}":{"get":{"tags":["PropertiesController"],"summary":"All properties for the specified branch:-","operationId":"PropertiesController_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/InspectionsPropertyModelResults"}}}}},"/V4/inspections/{shortName}/properties/{propertyID}":{"get":{"tags":["PropertiesController"],"summary":"Retrieves a property from it's unique ID:-","operationId":"PropertiesController_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 unique property ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsPropertyModel"}}}}},"/V4/inspections/{shortName}/properties/{propertyID}/landlord/period":{"get":{"tags":["PropertiesController"],"summary":"Retrieves the landlord for a property at a certain period:-","operationId":"PropertiesController_GetLandlordWithinPeriod","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 unique property ID:-","required":true,"type":"string"},{"name":"startDate","in":"query","description":"The date to commence the search from","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The date to search until","required":true,"type":"string","format":"date-time"},{"name":"integrator","in":"query","description":"Integrator(optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionContactModel"}}}}},"/V4/inspections/{shortName}/properties/{propertyID}/tenancies/latest":{"get":{"tags":["PropertiesController"],"summary":"Retrieves the latest tenancy for a property from the property's ID:-","operationId":"PropertiesController_GetLatestTenancy","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 unique property ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsTenancyModel"}}}}},"/V4/inspections/{shortName}/properties/{propertyID}/tenancies/period":{"get":{"tags":["PropertiesController"],"summary":"Searches a property for it's tenancy during the search dates period:-","operationId":"PropertiesController_GetTenancyWithinPeriod","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 unique property ID","required":true,"type":"string"},{"name":"startDate","in":"query","description":"The date to commence the search from","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The date to search until","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsTenancyModel"}}}}},"/v4/inspections/{shortName}/tenancies/{tenancyID}":{"get":{"tags":["TenanciesController"],"summary":"Retrieve a tenancy by it's unique ID:-","operationId":"TenanciesController_GetTenancyByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"The unique tenancy ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionsTenancyModel"}}}}},"/v4/inspections/{shortName}/tenancies/{tenancyID}/tenants":{"get":{"tags":["TenanciesController"],"summary":"Retrieve a tenancy's tenants:-","operationId":"TenanciesController_GetTenancyTenants","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"tenancyID","in":"path","description":"The unique tenancy ID","required":true,"type":"string"},{"name":"offset","in":"query","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","description":"The number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"},{"name":"integrator","in":"query","description":"integrator(optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InspectionTenantContactModelResults"}}}}}},"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"}}},"InspectionsStaffModelResults":{"description":"Inspectiosn Staff Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/InspectionsStaffModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"InspectionsStaffModel":{"description":"Inspections Staff Model:-","type":"object","properties":{"OID":{"description":"Staff member OID:-","type":"string"},"ETag":{"description":"Staff member E-Tag:-","type":"string"},"GlobalReference":{"description":"Staff member global reference:-","type":"string"},"LinkedBranch":{"$ref":"#/definitions/LinkedObjectModel","description":"Staff member branch ID:-"},"Title":{"description":"Staff member title:-","type":"string"},"Forename":{"description":"Staff member forename:-","type":"string"},"Middlename":{"description":"Staff member middle name:-","type":"string"},"Surname":{"description":"Staff member surname:-","type":"string"},"Links":{"description":"Hypermedia links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"LinkedObjectModel":{"description":"Generic Model for a Linked Object to provide information of the object OID and ETag to see if data has changed:-","type":"object","properties":{"OID":{"description":"Object ID:-","type":"string"},"ETag":{"description":"Current version:-","type":"string"}}},"InspectionTenantContactModel":{"description":"Contacts Person Model:-","type":"object","properties":{"OID":{"description":"The unique user ID:-","type":"string"},"GlobalReference":{"description":"The user's global reference:-","type":"string"},"CrmGroup":{"description":"The CRM Group of the user:-","type":"string"},"PersonType":{"description":"User Type:-","type":"string"},"IsHeadTenant":{"description":"Is Head Tenant:-","type":"boolean","readOnly":true},"Email":{"description":"User email address:-","type":"string"},"Title":{"description":"User title:-","type":"string"},"Forename":{"description":"User forename:-","type":"string"},"Surname":{"description":"User surname:-","type":"string"},"Salutation":{"description":"User salutation:-","type":"string"},"Mobile":{"description":"User mobile number:-","type":"string"},"Phone":{"description":"User landline number:-","type":"string"},"Address1":{"description":"User address 1:-","type":"string"},"Address2":{"description":"User address 2:-","type":"string"},"Address3":{"description":"User address 3:-","type":"string"},"Address4":{"description":"User address 4:-","type":"string"},"Postcode":{"description":"User postcode:-","type":"string"},"Country":{"description":"User country:-","type":"string"},"GDPRConsent":{"description":"User has provided GDPR consent?:-","type":"boolean"},"Links":{"$ref":"#/definitions/BaseHypermediaLink","description":"Hypermedia links:-"}}},"InspectionContactModel":{"description":"Contacts Person Model:-","type":"object","properties":{"OID":{"description":"The unique user ID:-","type":"string"},"GlobalReference":{"description":"The user's global reference:-","type":"string"},"CrmGroup":{"description":"The CRM Group of the user:-","type":"string"},"PersonType":{"description":"User Type:-","type":"string"},"Email":{"description":"User email address:-","type":"string"},"Title":{"description":"User title:-","type":"string"},"Forename":{"description":"User forename:-","type":"string"},"Surname":{"description":"User surname:-","type":"string"},"Salutation":{"description":"User salutation:-","type":"string"},"Mobile":{"description":"User mobile number:-","type":"string"},"Phone":{"description":"User landline number:-","type":"string"},"Address1":{"description":"User address 1:-","type":"string"},"Address2":{"description":"User address 2:-","type":"string"},"Address3":{"description":"User address 3:-","type":"string"},"Address4":{"description":"User address 4:-","type":"string"},"Postcode":{"description":"User postcode:-","type":"string"},"Country":{"description":"User country:-","type":"string"},"GDPRConsent":{"description":"User has provided GDPR consent?:-","type":"boolean"},"Links":{"$ref":"#/definitions/BaseHypermediaLink","description":"Hypermedia links:-"}}},"InspectionsDiaryAppointmentTypesModelResults":{"description":"Holds results from a paged query returning DiaryAppointmentTypeModel values:-","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range:-","type":"array","items":{"$ref":"#/definitions/InspectionsDiaryAppointmentTypesModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"InspectionsDiaryAppointmentTypesModel":{"description":"Inspections Diary Appointment Types Model:-","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 appointment type name:-","type":"string"},"SystemType":{"description":"The appointment system type:-","enum":["Viewing","ViewAndValue","OpeningInspection","InterimInspection","ClosingInspection","SalesAppraisal","Custom"],"type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"InspectionsDiaryAppointmentModelResults":{"description":"Holds results from a paged query returning DiaryAppointmentModel values:-","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range:-","type":"array","items":{"$ref":"#/definitions/InspectionsDiaryAppointmentModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"InspectionsDiaryAppointmentModel":{"description":"Inspections Diary Appointment Model:-","type":"object","properties":{"OID":{"description":"The unique appointment ID:-","type":"string"},"ETag":{"description":"The appointment E-Tag:-","type":"string"},"CreatedAt":{"format":"date-time","description":"Date appointment was created:-","type":"string"},"Start":{"format":"date-time","description":"Date Time the appointment starts:-","type":"string"},"End":{"format":"date-time","description":"Date Time the appointment ends:-","type":"string"},"Subject":{"description":"The appointment subject:-","type":"string"},"Comment":{"description":"The appointment comment:-","type":"string"},"LinkedStaffMember":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique staff ID of the staff member linked to the appointment:-"},"CreatedBy":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique staff ID of the staff member who created the appointment:-"},"Cancelled":{"description":"Is the appointment cancelled?:-","type":"boolean"},"AppointmentType":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique appointment type ID:-"},"RemindAt":{"format":"date-time","description":"Date Time for appointment reminder:-","type":"string"},"RemindBefore":{"description":"The number of minutes before the appointment start date/time to remind the staff member. -1 means don't remind.:-","enum":["Min","Min2","Min5","Min10","Min15","Min30","Min45","Hour","Hour2","Hour3","Hour6","Hour12","Day","Day2","Day3","Week","NoReminder"],"type":"string"},"LinkedProperties":{"description":"Array of Linked Properties' unique OIDs:-","type":"array","items":{"$ref":"#/definitions/LinkedObjectModel"}},"Recurrence":{"format":"int32","description":"The recurrence interval of the appointment:-","type":"integer"},"RecurrenceType":{"description":"The recurrence type of the appointment:-","type":"string"},"NextRecurringDate":{"format":"date-time","description":"The next recurring date of the appointment:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseDocumentSubmissionModel":{"description":"Base Document Submission Model:-","type":"object","properties":{"Name":{"description":"The name of the document","type":"string"},"URL":{"description":"The document URL","type":"string"},"DocumentType":{"description":"The document type","enum":["General","LettinsTenancyDocument","LettingsOpeningInventory","LettingsClosingInspection","HistoricDrawDownReport","CalmonyAMLExemptionEvidence","CalmonyProofOfAddress","LandlordPortfolioGenerating","LandlordPortfolioExtendedGenerating","LandlordPortfolio","LandlordPortfolioExtended","LandlordPortfolioGeneratingNoVAT","LandlordPortfolioExtendedGeneratingNoVAT"],"type":"string"},"MimeType":{"description":"The document MIMEType","type":"string"},"ExternalDocument":{"description":"Add a link to an external document? This would store \r\nthe link instead of the actual document.","type":"boolean"},"PublicLink":{"description":"Is this a public document? (This will allow public links to be generated)","type":"boolean"}}},"InspectionsPropertyModel":{"description":"Inspections Property Model:-","type":"object","properties":{"OID":{"description":"The unique property ID:-","type":"string"},"ETag":{"description":"The property E-Tag:-","type":"string"},"GlobalReference":{"description":"The unique property global reference:-","type":"string"},"LinkedBranch":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique branch OID:-"},"ManagedBy":{"$ref":"#/definitions/LinkedObjectModel","description":"Managed By:-"},"AddressNumber":{"description":"Property address number:-","type":"string"},"FlatRoomNumber":{"description":"Flat Room Number:-","type":"string"},"Address1":{"description":"Property address line 1:-","type":"string"},"Address2":{"description":"Property address line 2:-","type":"string"},"Address3":{"description":"Property address line 3:-","type":"string"},"Address4":{"description":"Property address line 4:-","type":"string"},"Postcode":{"description":"Property postcode:-","type":"string"},"LinkedLandlord":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique landlord ID of the main landlord:-"},"LinkedLatestTenancy":{"$ref":"#/definitions/LinkedInspectionsTenancyModel","description":"The unique ID of the latest tenancy on the property:-"},"Links":{"description":"Hypermedia links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"LinkedInspectionsTenancyModel":{"type":"object","properties":{"OID":{"description":"Object ID:-","type":"string"},"ETag":{"description":"Current version:-","type":"string"},"TenancyState":{"description":"The Tenancy State:-","type":"string","readOnly":true}}},"InspectionsTenancyModel":{"description":"Inspections Tenancy Model:-","type":"object","properties":{"OID":{"description":"The uniqe tenancy ID:-","type":"string"},"ETag":{"description":"The tenancy E-Tag:-","type":"string"},"GlobalReference":{"description":"The unique tenancy global reference:-","type":"string"},"LinkedBranch":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique branch ID of the branch associated with the tenancy:-"},"LinkedProperty":{"$ref":"#/definitions/LinkedObjectModel","description":"The unique ID of the property associated with the tenancy:-"},"TenancyStartDate":{"format":"date-time","description":"The start date of the tenancy:-","type":"string"},"TenancyFixedDate":{"format":"date-time","description":"The date the tenancy goes from fixed period to rolling contract:-","type":"string"},"TenancyEndDate":{"format":"date-time","description":"The end date of the tenancy:-","type":"string"},"LinkedTenants":{"description":"An array of the unique tenant IDs for all tenants on the tenancy:-","type":"array","items":{"$ref":"#/definitions/LinkedObjectModel"}},"Links":{"description":"Hypermedia links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"InspectionsPropertyModelResults":{"description":"Property model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/InspectionsPropertyModel"},"readOnly":true},"Count":{"format":"int32","description":"Results Count:-","type":"integer","readOnly":true},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"},"readOnly":true}}},"InspectionTenantContactModelResults":{"description":"Contacts Person Model Results:-","type":"object","properties":{"Data":{"description":"Results data:-","type":"array","items":{"$ref":"#/definitions/InspectionTenantContactModel"}},"Count":{"format":"int32","description":"Results count:-","type":"integer"},"Links":{"description":"Results links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}