{"swagger":"2.0","info":{"version":"v4-appointments","title":"agentOS Api V4, Appointments Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/appointments/{shortName}/appointment/update":{"patch":{"tags":["DiaryController"],"summary":"Update an existing appointment using its unique identifier","operationId":"DiaryController_UpdateAppointment","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":"appointmentID","in":"query","description":"The unique appointment id","required":true,"type":"string"},{"name":"appointmentDetails","in":"body","description":"The appointment details model","required":true,"schema":{"$ref":"#/definitions/AppointmentDiaryEntryUpdateSubmissionModel"}},{"name":"lettings","in":"query","description":"Sales or Lettings property?","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/appointments/{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/appointments/{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/appointments/{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/appointments/{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/appointments/{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/appointments/{shortName}/contacts/guest/match/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Match Guest Parameters with existing person:-","operationId":"ContactsController_MatchGuests","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":"forename","in":"query","description":"Guest forename","required":true,"type":"string"},{"name":"emailaddress","in":"query","description":"Guest Email Address","required":true,"type":"string"},{"name":"surname","in":"query","description":"Guest Surname","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/DiaryAppointmentGuestResultsModel"}}}}},"/v4/appointments/{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/DiaryAppointmentStaffModelResults"}}}}},"/v4/appointments/{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/DiaryAppointmentStaffModel"}}}}},"/v4/appointments/{shortName}/diary":{"post":{"tags":["DiaryController"],"summary":"Post an appointment into a valid diary allocation:-","operationId":"DiaryController_PostAppointment","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-nam","required":true,"type":"string"},{"name":"propertyID","in":"query","description":"The unique property identifier (Sales or Lettings)","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"appointmentDetails","in":"body","description":"The appointment submission model","required":true,"schema":{"$ref":"#/definitions/AppointmentDiaryEntrySubmissionModel"}},{"name":"lettings","in":"query","description":"Is property a lettings property","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/appointments/{shortName}/diary/appointment/{appointmentID}":{"get":{"tags":["DiaryController"],"summary":"Retrieve appointment by 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 type ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiaryAppointmentModel"}}}}},"/v4/appointments/{shortName}/diary/appointments/{branchID}/{offset}/{count}":{"get":{"tags":["DiaryController"],"summary":"Retrieve diary appointments linked to a branch filtered between specific dates and by appointment type:-","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":"path","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"startDate","in":"query","description":"The search from date","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The search to date","required":true,"type":"string","format":"date-time"},{"name":"appointmentTypesToSearch","in":"query","description":"The appointment IDs to search for","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"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/DiaryAppointmentSummaryModelResults"}}}}},"/v4/appointments/{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/DiaryAppointmentTypeModel"}}}}},"/v4/appointments/{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/DiaryAppointmentTypeModelResults"}}}}},"/v4/appointments/{shortName}/diary/appointmenttypes/allocations/{offset}/{count}":{"get":{"tags":["DiaryController"],"summary":"Get a list of all available allocations for a date + 7 days for a specified appointment type:-","operationId":"DiaryController_GetAllocationsForAppointmentType","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"appointmentTypeID","in":"query","description":"The unique appointment type ID","required":true,"type":"string"},{"name":"preferredDate","in":"query","description":"The preferred dates","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"},{"name":"lettings","in":"query","description":"Is this a lettings property","required":false,"type":"boolean"},{"name":"propertyIdentifier","in":"query","description":"The unique property ID","required":false,"type":"string"},{"name":"branchID","in":"query","description":"The unique appointment type ID","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiaryAllocationModelModelResults"}}}}},"/v4/appointments/{shortName}/diary/cancelationStatus/{cancelationStatus}":{"patch":{"tags":["DiaryController"],"summary":"Modify the cancelation status of a diary appointment:-","operationId":"DiaryController_EditDiaryCancelationStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"appointmentID","in":"query","description":"The unique appointment ID","required":true,"type":"string"},{"name":"cancelationStatus","in":"path","description":"The cancelation status","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/appointments/{shortName}/diary/feedback":{"post":{"tags":["DiaryController"],"summary":"Post Feedback for a property:-","operationId":"DiaryController_PostFeedback","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-nam","required":true,"type":"string"},{"name":"feedbackDetails","in":"body","description":"The appointment submission model","required":true,"schema":{"$ref":"#/definitions/AppointmentFeedbackSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/appointments/{shortName}/diary/recurringappointment":{"get":{"tags":["DiaryController"],"summary":"Retrieves all recurring appointments:-","operationId":"DiaryController_GetRecurringAppointments","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 ID of the Branch","required":true,"type":"string"},{"name":"appointmentTypesToSearch","in":"query","description":"The appointment IDs to search for","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"offset","in":"query","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"query","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/DiaryAppointmentSummaryModelResults"}}}}},"/v4/appointments/{shortName}/lettings/tenancies/advertised/{offset}/{count}":{"get":{"tags":["LettingsController"],"summary":"Retrieve advertising tenancies set up in the system:-","operationId":"LettingsController_GetAdvertisingTenanciesForDiary","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":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"},{"name":"includeRenewals","in":"query","description":"Include renewals","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiaryLettingsAdvertisingModelResults"}}}}},"/v4/appointments/{shortName}/messaging/{branchID}":{"post":{"tags":["MessagingController"],"summary":"Send a new email via the the Branch:-","operationId":"MessagingController_SendEmailFromBranch","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 Branch ID","required":true,"type":"string"},{"name":"email","in":"body","description":"Email Submission model:-","required":true,"schema":{"$ref":"#/definitions/AppointmentEmailSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/appointments/{shortName}/sales/instructions/advertised/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"Retrieve advertising instructions set up in the system:-","operationId":"SalesController_GetAdvertisingInstructionsForDiary","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":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiaryInstructionsAdvertisingModelResults"}}}}}},"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"}}},"DiaryAppointmentStaffModelResults":{"description":"Diary Appointment Staff Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/DiaryAppointmentStaffModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"DiaryAppointmentStaffModel":{"description":"Diary Appointment Staff Model","type":"object","properties":{"OID":{"description":"The unique Object ID (OID):-","type":"string"},"DisplayName":{"description":"Staff Display Name:-","type":"string"}}},"DiaryAppointmentGuestResultsModel":{"description":"Contacts Person Model Results:-","type":"object","properties":{"Data":{"description":"Results data:-","type":"array","items":{"$ref":"#/definitions/DiaryAppointmentGuest"}},"Count":{"format":"int32","description":"Results count:-","type":"integer"},"Links":{"description":"Results links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"DiaryAppointmentGuest":{"type":"object","properties":{"OID":{"description":"Guest OID","type":"string","readOnly":true},"GlobalReference":{"description":"Guest Global Reference","type":"string","readOnly":true},"Forename":{"description":"Guest Forename","type":"string","readOnly":true},"Surname":{"description":"Guest Surname","type":"string","readOnly":true},"ContactMobile":{"description":"Guest Mobile Phone","type":"string","readOnly":true},"EmailAddress":{"description":"Guest Email Address","type":"string","readOnly":true}}},"DiaryAllocationModelModelResults":{"description":"Holds results from a paged query returning DiaryLettingsAdvertisingModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/DiaryAllocationModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"DiaryAllocationModel":{"description":"Diary Allocation Model","type":"object","properties":{"StaffFullName":{"description":"The full name of the staff:-","type":"string","readOnly":true},"StaffOID":{"description":"The unique ID of the staff member this allocation is with:-","type":"string","readOnly":true},"Start":{"format":"date-time","description":"Start of allocation:-","type":"string","readOnly":true},"End":{"format":"date-time","description":"End of the Allocation:-","type":"string","readOnly":true}}},"DiaryAppointmentTypeModelResults":{"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/DiaryAppointmentTypeModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"DiaryAppointmentTypeModel":{"description":"Represents a diary appointment type.","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"}}},"AppointmentDiaryEntrySubmissionModel":{"description":"Appointment Submit Diary Entry Submission Model","type":"object","properties":{"AllocationDetails":{"$ref":"#/definitions/AppointmentDiaryBookingModel","description":"Allocation details to link the appointment too"},"AppointmentType":{"description":"The Appointment Type ID","type":"string"},"Subject":{"description":"The subject of the appointment","type":"string"},"ExtraComments":{"description":"Additional appointment comments","type":"string"},"Guests":{"description":"A collection of guests linked to the appointment. If none leave empty","type":"array","items":{"$ref":"#/definitions/AppointmentDiaryGuestDetails"}}}},"AppointmentDiaryBookingModel":{"description":"Represents a viewing booking slot","type":"object","properties":{"Start":{"format":"date-time","description":"The start time of the booking","type":"string"},"End":{"format":"date-time","description":"The end time of the booking","type":"string"},"StaffName":{"description":"The name of the staff member this booking is with","type":"string"},"StaffID":{"description":"The unique ID of the staff member this booking is with","type":"string"}}},"AppointmentDiaryGuestDetails":{"description":"Submission Model - Structure to submit appointment guest details","type":"object","properties":{"OID":{"description":"The unique identifier of a user, only submit this is known","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"MobilePhone":{"description":"Mobile phone","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AllowMarketingCorrespondence":{"description":"Marketing Correspondence Preferences","type":"boolean"}}},"AppointmentFeedbackSubmissionModel":{"description":"Appointment Feedback Submission Model:-","type":"object","properties":{"AppointmentID":{"description":"Appointment to submit feedback to:-","type":"string"},"PropertyID":{"description":"Property to submit feedback to:-","type":"string"},"Feedback":{"description":"Feedback to submit:-","type":"string"}}},"DiaryAppointmentSummaryModelResults":{"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/DiaryAppointmentSummaryModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"DiaryAppointmentSummaryModel":{"description":"Represents a summary of a diary appointment.","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"},"CreatedAt":{"format":"date-time","description":"The date/time this appointment was created.","type":"string"},"Start":{"format":"date-time","description":"The start date/time of this appointment.","type":"string"},"End":{"format":"date-time","description":"The end date/time of this appointment.","type":"string"},"Subject":{"description":"The appointment subject text.","type":"string"},"Comment":{"description":"The appointment comments text.","type":"string"},"Staff":{"description":"The staff member holding this appointment.","type":"string"},"CreatedBy":{"description":"The staff member that created this appointment.","type":"string"},"Cancelled":{"description":"Whether the appointment has been cancelled.","type":"boolean"},"AppointmentType":{"description":"The diary appointment type.","type":"string"},"RemindAt":{"format":"date-time","description":"The date/time to remind the staff member of this appointment.","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":"A collection of properties linked to the appointment:-","type":"array","items":{"$ref":"#/definitions/LinkedPropertiesSummaryModel"}},"LinkedGuest":{"description":"Linked Guest Model:-","type":"array","items":{"$ref":"#/definitions/LinkedGuestSummaryModel"},"readOnly":true},"Recurrence":{"format":"int32","description":"The recurrence interval for the appointment:-","type":"integer"},"RecurrenceType":{"description":"The type of recurrence:-","type":"string"},"NextRecurringDate":{"format":"date-time","description":"Date appointment next repeats:-","type":"string"}}},"LinkedPropertiesSummaryModel":{"description":"Holds information on linked properties","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"MainLandlord":{"$ref":"#/definitions/LinkedLandlordSummaryModel","description":"The main landlord linked to the property"},"LatestTenancy":{"$ref":"#/definitions/LatestTenancySummaryModel","description":"The latest tenancy linked to the property"}}},"LinkedGuestSummaryModel":{"description":"Holds information on guests","type":"object","properties":{"OID":{"description":"Guest OID:-","type":"string","readOnly":true},"GlobalReference":{"description":"Guest Global Reference:-","type":"string","readOnly":true}}},"LinkedLandlordSummaryModel":{"description":"Holds information on landlords","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"}}},"LatestTenancySummaryModel":{"description":"Holds information on the most recent tenancy linked to the property.","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"GlobalReference":{"description":"The unique global reference of the Tenancy","type":"string"},"StartDate":{"format":"date-time","description":"The start date of the Tenancy","type":"string"},"FixedDate":{"format":"date-time","description":"The fixed date of the Tenancy","type":"string"},"EndDate":{"format":"date-time","description":"The end date of the Tenancy","type":"string"},"IsTenancyProposed":{"description":"Is the tenancy Proposed?","type":"boolean"},"IsTenancySigned":{"description":"Is the tenancy signed?","type":"boolean"},"IsTenancyEnded":{"description":"Has the Tenancy ended?","type":"boolean"},"LinkedTenants":{"description":"A collection of tenants linked to the tenancy:-","type":"array","items":{"$ref":"#/definitions/LinkedTenantSummaryModel"}}}},"LinkedTenantSummaryModel":{"description":"Holds information on tenants","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"}}},"DiaryAppointmentModel":{"description":"Represents a single diary appointment","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"},"CreatedAt":{"format":"date-time","description":"The date/time this appointment was created.","type":"string"},"Start":{"format":"date-time","description":"The start date/time of this appointment.","type":"string"},"End":{"format":"date-time","description":"The end date/time of this appointment.","type":"string"},"Subject":{"description":"The appointment subject text.","type":"string"},"Comment":{"description":"The appointment comments text.","type":"string"},"Staff":{"description":"The staff member holding this appointment.","type":"string"},"CreatedBy":{"description":"The staff member that created this appointment.","type":"string"},"Cancelled":{"description":"Whether the appointment has been cancelled.","type":"boolean"},"AppointmentType":{"description":"The diary appointment type.","type":"string"},"RemindAt":{"format":"date-time","description":"The date/time to remind the staff member of this appointment.","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":"A collection of properties linked to the appointment:-","type":"array","items":{"$ref":"#/definitions/LinkedPropertiesModel"}},"LinkedGuest":{"description":"Linked Guest Model:-","type":"array","items":{"$ref":"#/definitions/LinkedGuestModel"},"readOnly":true},"Recurrence":{"format":"int32","description":"The recurrence interval for the appointment:-","type":"integer"},"RecurrenceType":{"description":"The type of recurrence:-","type":"string"},"NextRecurringDate":{"format":"date-time","description":"Date appointment next repeats:-","type":"string"}}},"LinkedPropertiesModel":{"description":"Holds information on linked properties","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"AddressNumber":{"description":"Address Number","type":"string"},"AddressFlatRoomNumber":{"description":"Address Flat Room Number","type":"string"},"Address1":{"description":"Address 1","type":"string"},"Address2":{"description":"Address2","type":"string"},"Address3":{"description":"Address 3","type":"string"},"Address4":{"description":"Address 4","type":"string"},"Postcode":{"description":"Postcode","type":"string"},"MainLandlord":{"$ref":"#/definitions/LinkedLandlordModel","description":"The main landlord linked to the property"},"LatestTenancy":{"$ref":"#/definitions/LatestTenancyModel","description":"The latest tenancy linked to the property"}}},"LinkedGuestModel":{"description":"Holds information on guests","type":"object","properties":{"OID":{"description":"Guest OID:-","type":"string","readOnly":true},"GlobalReference":{"description":"Guest Global Reference:-","type":"string","readOnly":true},"CreatedAt":{"format":"date-time","description":"Guest Created At:-","type":"string","readOnly":true},"Name":{"description":"Guest Name:-","type":"string","readOnly":true},"Email":{"description":"Guest Email:-","type":"string","readOnly":true},"Mobile":{"description":"Guest Mobile:-","type":"string","readOnly":true}}},"LinkedLandlordModel":{"description":"Holds information on landlords","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"PhoneNumber":{"description":"Landlord's phone number","type":"string"},"Email":{"description":"Landlord's email address","type":"string"}}},"LatestTenancyModel":{"description":"Holds information on the most recent tenancy linked to the property.","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"GlobalReference":{"description":"The unique global reference of the Tenancy","type":"string"},"StartDate":{"format":"date-time","description":"The start date of the Tenancy","type":"string"},"FixedDate":{"format":"date-time","description":"The fixed date of the Tenancy","type":"string"},"EndDate":{"format":"date-time","description":"The end date of the Tenancy","type":"string"},"IsTenancyProposed":{"description":"Is the tenancy Proposed?","type":"boolean"},"IsTenancySigned":{"description":"Is the tenancy signed?","type":"boolean"},"IsTenancyEnded":{"description":"Has the Tenancy ended?","type":"boolean"},"LinkedTenants":{"description":"A collection of tenants linked to the tenancy:-","type":"array","items":{"$ref":"#/definitions/LinkedTenantModel"}},"AccessArrangements":{"description":"Access Arrangements","type":"string","readOnly":true},"AccessName1":{"description":"Arrange access contact name 1","type":"string","readOnly":true},"AccessName2":{"description":"Arrange access contact name 2","type":"string","readOnly":true},"AccessName3":{"description":"Arrange access contact name 3","type":"string","readOnly":true},"AccessMobile1":{"description":"Arrange access Mobile 1","type":"string","readOnly":true},"AccessMobile2":{"description":"Arrange access Mobile 2","type":"string","readOnly":true},"AccessMobile3":{"description":"Arrange access Mobile 3","type":"string","readOnly":true}}},"LinkedTenantModel":{"description":"Holds information on tenants","type":"object","properties":{"OID":{"description":"OID","type":"string"},"ETag":{"description":"ETag","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"PhoneNumber":{"description":"Tenant's phone number","type":"string"},"Email":{"description":"Tenant's email address","type":"string"}}},"AppointmentDiaryEntryUpdateSubmissionModel":{"description":"Appointment Submit Diary Entry Submission Model","type":"object","properties":{"AllocationDetails":{"$ref":"#/definitions/AppointmentDiaryUpdateBookingModel","description":"Allocation details to link the appointment too"},"AppointmentType":{"description":"The Appointment Type ID","type":"string"},"Subject":{"description":"The subject of the appointment","type":"string"},"ExtraComments":{"description":"Additional appointment comments","type":"string"},"Guests":{"description":"A collection of guests linked to the appointment. If none leave empty","type":"array","items":{"$ref":"#/definitions/AppointmentDiaryUpdateGuestDetails"}}}},"AppointmentDiaryUpdateBookingModel":{"description":"Represents a viewing booking slot","type":"object","properties":{"Start":{"format":"date-time","description":"The start time of the booking","type":"string"},"End":{"format":"date-time","description":"The end time of the booking","type":"string"},"StaffName":{"description":"The name of the staff member this booking is with","type":"string"},"StaffID":{"description":"The unique ID of the staff member this booking is with","type":"string"}}},"AppointmentDiaryUpdateGuestDetails":{"description":"Submission Model - Structure to submit appointment guest details","type":"object","properties":{"OID":{"description":"The unique identifier of a user, only submit this is known","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"MobilePhone":{"description":"Mobile phone","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AllowMarketingCorrespondence":{"description":"Marketing Correspondence Preferences","type":"boolean"}}},"DiaryLettingsAdvertisingModelResults":{"description":"Holds results from a paged query returning DiaryLettingsAdvertisingModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/DiaryLettingsAdvertisingModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"DiaryLettingsAdvertisingModel":{"description":"Diary Lettings Advertising Model:-","type":"object","properties":{"OID":{"description":"The unique Object ID (OID):-","type":"string","readOnly":true},"PropertyOID":{"description":"The unique Object ID (OID) for the property:-","type":"string","readOnly":true},"GlobalReference":{"description":"The tenancy global reference:-","type":"string","readOnly":true},"Etag":{"description":"A unique identifier defining the object and change revision:-","type":"string","readOnly":true},"Address":{"$ref":"#/definitions/BaseAddressModel","description":"Tenancy Property address helper model:-","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"}}},"AppointmentEmailSubmissionModel":{"description":"Submit Appointment Email Submission Model:-","type":"object","properties":{"Subject":{"description":"EMail subject:-","type":"string"},"Content":{"description":"Email content:-","type":"string"},"To":{"description":"Email addresses to send the email to:-","type":"array","items":{"type":"string"}},"CC":{"description":"Email addresses to CC onto the email:-","type":"array","items":{"type":"string"}},"BCC":{"description":"Email addresses to BCC onto the email:-","type":"array","items":{"type":"string"}}}},"DiaryInstructionsAdvertisingModelResults":{"description":"Holds results from a paged query returning DiaryInstructionsAdvertisingModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/DiaryInstructionsAdvertisingModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"DiaryInstructionsAdvertisingModel":{"description":"Diary Instructions Advertising Model:-","type":"object","properties":{"OID":{"description":"The unique Object ID (OID):-","type":"string","readOnly":true},"GlobalReference":{"description":"The sales instruction global reference:-","type":"string","readOnly":true},"Etag":{"description":"A unique identifier defining the object and change revision:-","type":"string","readOnly":true},"Address":{"$ref":"#/definitions/BaseAddressModel","description":"Sales Instruction Address helper model:-","readOnly":true}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}