{"swagger":"2.0","info":{"version":"v4-applications","title":"agentOS Api V4, Applications Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/applications/{shortName}/buyer/{branchID}/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Retrieve all buyers of the given branch:-","operationId":"ContactsController_GetBuyersByBranch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique branch ID to retrieve prospects for","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first prospect to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of prospects to return","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicantBuyerResultsModel"}}}}},"/v4/applications/{shortName}/buyers/{prospectID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve a buyer by their ID:-","operationId":"ContactsController_GetBuyeryID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"prospectID","in":"path","description":"The unique prospect ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicantBuyer"}}}}},"/v4/applications/{shortName}/company/areas/{areaID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific area given its unique Object ID(OID)","operationId":"CompanyController_GetArea","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"areaID","in":"path","description":"The unique ID of the Area","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingAreaModel"}}}}},"/v4/applications/{shortName}/company/areas/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"A collection of all the areas for a company","operationId":"CompanyController_GetAreas","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/AdvertisingAreaModelResults"}}}}},"/v4/applications/{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/applications/{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/applications/{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/applications/{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/applications/{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/applications/{shortName}/documents/prospects/{applicantID}/add":{"post":{"tags":["DocumentsController"],"summary":"Add a document to an applicants \"Print/Post/Store Document\" 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":"applicantID","in":"path","description":"The unique applicant ID","required":true,"type":"string"},{"name":"document","in":"body","description":"The document to add","required":true,"schema":{"$ref":"#/definitions/BaseDocumentSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/documents/sales/{buyerID}/add":{"post":{"tags":["DocumentsController"],"summary":"Add a document to an buyers \"Print/Post/Store Document\" section:-","description":"If the document is over 10mb in size it will be added as an external document.","operationId":"DocumentsController_LookupSalesApplicantBuyer","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":"buyerID","in":"path","description":"The unique buyer ID","required":true,"type":"string"},{"name":"document","in":"body","description":"The document to add","required":true,"schema":{"$ref":"#/definitions/BaseDocumentSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/prospects/{applicantID}/applicants/{offset}/{count}":{"get":{"tags":["ProspectsController"],"summary":"Return matching Letting properties:-","operationId":"ProspectsController_GetMatchingLettingsProperty","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"applicantID","in":"path","description":"The unique applicant ID","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/MatchingLettingsResultsModelResults"}}}}},"/v4/applications/{shortName}/prospects/{branchID}":{"post":{"tags":["ProspectsController"],"summary":"Batch create new prospects in the system:-","operationId":"ProspectsController_BatchCreateApplicants","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"prospectsData","in":"body","description":"The collection of prospects to create","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/TenancyApplicationWithAlertsDirect"}}},{"name":"branchID","in":"path","description":"The unique branchID link the prospects to","required":true,"type":"string"},{"name":"staffID","in":"query","description":"Link a staff member to the prospects? (optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/v4/applications/{shortName}/prospects/{branchID}/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Retrieve all prospects of the given branch:-","operationId":"ContactsController_GetApplicants","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique branch ID to retrieve prospects for","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first prospect to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of prospects to return","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicantResultsModel"}}}}},"/v4/applications/{shortName}/prospects/{branchID}/alerts":{"post":{"tags":["ProspectsController"],"summary":"Create Lettings Property Alerts:-","operationId":"ProspectsController_CreateLettingPropertyAlerts","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"prospectData","in":"body","description":"The data for the prospect to be created","required":true,"schema":{"$ref":"#/definitions/ApplicantSubmissionModel"}},{"name":"branchID","in":"path","description":"The branch to link the prospect to","required":true,"type":"string"},{"name":"staffID","in":"query","description":"Link a staff member to the prospect? (optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/prospects/prospect/{prospectID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve a prospect by their ID:-","operationId":"ContactsController_GetApplicant","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"prospectID","in":"path","description":"The unique prospect ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicantModel"}}}},"patch":{"tags":["ProspectsController"],"summary":"Updates the data for a created prospect in the system:-","operationId":"ProspectsController_UpdateApplicant","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"prospectID","in":"path","description":"The ID of the prospect to modify","required":true,"type":"string"},{"name":"prospectData","in":"body","description":"The prospect data to update","required":true,"schema":{"$ref":"#/definitions/ApplicantSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/prospects/submittenancyapplication":{"post":{"tags":["ProspectsController"],"summary":"Submit an Online Tenancy Application to the In Tray and email successful applicant:-","operationId":"ProspectsController_SubmitTenancyApplication","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":"query","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"applicationData","in":"body","description":"The data for the Applicant to be created","required":true,"schema":{"$ref":"#/definitions/TenancyApplicationWithAlerts"}},{"name":"staffID","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/prospects/tenancyapplication/{branchID}":{"post":{"tags":["ProspectsController"],"summary":"Create a new prospect directly to the system and successful email applicant :-","operationId":"ProspectsController_CreateApplicant","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortName","required":true,"type":"string"},{"name":"prospectData","in":"body","description":"The data for the prospect to be created","required":true,"schema":{"$ref":"#/definitions/TenancyApplicationWithAlertsDirect"}},{"name":"branchID","in":"path","description":"The branch to link the prospect to","required":true,"type":"string"},{"name":"staffID","in":"query","description":"Link a staff member to the prospect? (optional)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/sales/{applicantID}/salesinstructions/{offset}/{count}":{"get":{"tags":["SalesController"],"summary":"Return matching Sales Properties:-","operationId":"SalesController_GetMatchingSalesApplicants","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"applicantID","in":"path","description":"The unique applicant ID","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/MatchingSalesResultsModelResults"}}}}},"/v4/applications/{shortName}/sales/{branchID}/sales/alerts":{"post":{"tags":["SalesController"],"summary":"Create Buyer sales alert:-","operationId":"SalesController_CreateApplicantBuyerSubmission","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 company shortName","required":true,"type":"string"},{"name":"submissionModel","in":"body","description":"Submission model","required":true,"schema":{"$ref":"#/definitions/ApplicantBuyerSubmissionModel"}},{"name":"preferredContact","in":"query","description":"Preferred Contact Method","required":true,"type":"string","enum":["Telephone","SMS","Email","Letter"]},{"name":"staffID","in":"query","description":"The unique staff ID","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/sales/{salesInstructionID}/offer":{"post":{"tags":["SalesController"],"summary":"Submit Sales offer for Sales Instruction:-","operationId":"SalesController_SubmitSalesOffer","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":"query","description":"The unique branch ID","required":true,"type":"string"},{"name":"salesInstructionID","in":"path","description":"The unique ID of the Sales Offer","required":true,"type":"string"},{"name":"salesOfferDetails","in":"body","description":"The sales offer submission details","required":true,"schema":{"$ref":"#/definitions/SalesOfferSubmissionModel"}},{"name":"applicantsForename","in":"query","description":"Applicants forename","required":true,"type":"string"},{"name":"applicantsSurname","in":"query","description":"Applicants Surname","required":true,"type":"string"},{"name":"phoneNumber","in":"query","description":"Applicants contact number","required":true,"type":"string"},{"name":"email","in":"query","description":"Applicants email","required":true,"type":"string"},{"name":"depositType","in":"query","description":"Type of deposit","required":true,"type":"string","enum":["Cash","GiftedDeposit","HelpToBuyScheme","HelpToBuyISA","Other"]}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/applications/{shortName}/sales/salesoffer/{salesOfferID}":{"get":{"tags":["SalesController"],"summary":"Get a specific sales offer given its unique Object ID(OID):-","operationId":"SalesController_GetSalesOfferByOID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesOfferID","in":"path","description":"The unique ID of the Sales Offer","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SalesOfferModel"}}}}},"/v4/applications/{shortName}/staff/{offset}/{count}":{"get":{"tags":["StaffController"],"summary":"Get all staff members from system:-","operationId":"StaffController_GetStaffMembers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"offset","in":"path","description":"Index of first staff member to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The number of staff members to return","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseStaffMemberResultsModel"}}}}},"/v4/applications/{shortName}/staff/{staffID}":{"get":{"tags":["StaffController"],"summary":"Get a staff member associated with the ID:-","operationId":"StaffController_GetStaffMember","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client shortname","required":true,"type":"string"},{"name":"staffID","in":"path","description":"The staff member ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseStaffMemberModel"}}}}}},"definitions":{"AdvertisingAreaModelResults":{"description":"Holds results from a paged query returning AreaModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingAreaModel"}},"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"}}}},"AdvertisingAreaModel":{"description":"Stores the information about a single property area.","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 property area name.","type":"string"},"BranchOID":{"description":"The branch that manages this area.","type":"string"},"ShowOnSites":{"description":"Show the area on sites?","type":"boolean"},"Links":{"description":"Base 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"}}},"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"}}}},"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"}}},"ApplicantResultsModel":{"description":"Applicant Results Model:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ApplicantModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ApplicantModel":{"description":"Applicant Model:-","type":"object","properties":{"OID":{"description":"The unique applicant ID:-","type":"string"},"Title":{"description":"The applicants title:-","type":"string"},"Forename":{"description":"The applicants forename:-","type":"string"},"Middlename":{"description":"The applicants middle name:-","type":"string"},"Surname":{"description":"The applicants surname:-","type":"string"},"Address":{"$ref":"#/definitions/BaseAddressModel","description":"Base Address Model:-"},"AlertEnabled":{"description":"Alert Enabled?:-","type":"boolean"},"PropertyCriteria":{"$ref":"#/definitions/ApplicantPropertyCriteria","description":"Applicant Property Criteria Model:-","readOnly":true},"Email":{"description":"Applicants email address:-","type":"string"},"Mobile":{"description":"Applicant's mobile number:-","type":"string"},"CreatedDate":{"format":"date-time","description":"Created At:-","type":"string"},"CreatedBy":{"description":"The ID of the staff member that created the applicant:-","type":"string"},"DateOfBirth":{"format":"date-time","description":"Applicants date of birth:-","type":"string"},"Landline":{"description":"Applicants landline number:-","type":"string"},"ManagedBy":{"description":"The ID of the branch that manages the applicant:-","type":"string"},"Nationality":{"description":"The applicants nationality:-","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string"},"Negotiator":{"description":"ID of the applicants negotiator:-","type":"string"},"NoteCount":{"format":"int32","description":"The number of notes on an applicant:-","type":"integer"},"NotifyUntilDate":{"description":"The date to notify the applicant until:-","type":"string"},"OfferCount":{"format":"int32","description":"Number of offers the applicants made:-","type":"integer"},"PersonType":{"description":"Person Type:-","type":"string"},"ProspectStatus":{"description":"The status of the applicant:-","type":"string"},"WantSharedProperty":{"description":"Does the applicant want a room in a shared property:-","type":"boolean"},"LettingAlerts":{"$ref":"#/definitions/ApplicantLettingsAlerts","description":"Applicant Lettings Alert 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"}}},"ApplicantPropertyCriteria":{"type":"object","properties":{"MaximumBeds":{"format":"int32","description":"Alert for properties that contain the maximum numbers of beds:-","type":"integer"},"MinimumBeds":{"format":"int32","description":"Alert for properties that contain the minimum number of beds:-","type":"integer"},"LettingsFacilitiesCount":{"format":"int32","description":"Number of lettings facilities applicant has alerts for:-","type":"integer"},"AreaCount":{"format":"int32","description":"Number of areas applicant has alerts for:-","type":"integer"},"PropertyFacilitiesCount":{"format":"int32","description":"Number of property facilities applicant has alerts for:-","type":"integer"},"RentMaximum":{"format":"double","description":"Alert applicant if property rent below maximum:-","type":"number"},"RentMinimum":{"format":"double","description":"Alert applicant if property rent above minimum:-","type":"number"},"RentMaximumDaily":{"format":"double","description":"Alert applicant if property daily rent below maximum:-","type":"number"},"RentMinimumDaily":{"format":"double","description":"Alert applicant if property daily rent above minimum:-","type":"number"},"RentRecurrence":{"format":"int32","description":"Alert applicant if rent recurrence matches applicant's preferred rent recurrence:-","type":"integer"},"RentSchedule":{"description":"Alert applicant if rent schedule matches applicant's preferred rent schedule:-","enum":["Once","Daily","Weekly","Monthly","Yearly"],"type":"string"},"TenantType":{"description":"Alert applicant if property allows tenant type:-","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"Furnished":{"description":"Alert for properties that are furnished:-","enum":["Unfurnished","PartFurnished","Furnished"],"type":"string"}}},"ApplicantLettingsAlerts":{"type":"object","properties":{"AvailableFrom":{"format":"date-time","description":"Available from:-","type":"string"},"LastLetterSent":{"format":"date-time","description":"Alert for the date of the last letter sent:-","type":"string"},"LastNotified":{"format":"date-time","description":"Alert for the date last notified:-","type":"string"},"NotifyByEmail":{"description":"Notify applicant by email:-","type":"boolean"},"NotifyByPost":{"description":"Notify applicant by post:-","type":"boolean"},"NotifyByText":{"description":"Notify By Text:-","type":"boolean"}}},"ApplicantSubmissionModel":{"description":"","type":"object","properties":{"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"MobilePhone":{"description":"Mobile Phone","type":"string"},"EmailAddress":{"description":"Email Address","type":"string"},"TenantType":{"description":"Tenant Type","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"AreaID":{"description":"Area ID","type":"string"},"EmailAlerts":{"description":"Email Alerts","type":"boolean"},"SMSAlerts":{"description":"SMS Alerts","type":"boolean"},"MinRent":{"format":"double","description":"The Minimum Rent Value","type":"number"},"MaxRent":{"format":"double","description":"The Maximum Rent Value","type":"number"},"NumberOfBeds":{"format":"int32","description":"Number of Beds","type":"integer"},"RoomInSharedProperty":{"description":"Prospcect Accept Shared Rooms?","type":"boolean"}}},"ApplicantBuyerResultsModel":{"description":"Applicant Buyer Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ApplicantBuyer"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"ApplicantBuyer":{"type":"object","properties":{"Title":{"description":"Buyers Title:-","type":"string","readOnly":true},"Middlemame":{"description":"Buyers Middlename:-","type":"string","readOnly":true},"Forename":{"description":"Buyers Forename:-","type":"string","readOnly":true},"Surname":{"description":"Buyers Surname:-","type":"string","readOnly":true},"Landphone":{"description":"Buyers Landphone:-","type":"string","readOnly":true},"Mobile":{"description":"Buyers Mobile:-","type":"string","readOnly":true},"Country":{"description":"Buyers Country:-","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string","readOnly":true},"Email":{"description":"Buyers Email:-","type":"boolean","readOnly":true},"PreferedContactMethod":{"description":"Prefered Contact Method:-","enum":["Telephone","SMS","Email","Letter"],"type":"string","readOnly":true},"LeadSource":{"description":"Lead Source:-","type":"string","readOnly":true},"AlertEnabled":{"description":"Alert Enabled:-","type":"boolean","readOnly":true},"EmailLetters":{"description":"Email Letters:-","type":"boolean","readOnly":true},"ProfileExpires":{"format":"date-time","description":"Date Profile Expires:-","type":"string","readOnly":true},"Alerts":{"$ref":"#/definitions/buyerAlerts","description":"Buyer Alerts Model:-","readOnly":true},"PropertyRequirements":{"$ref":"#/definitions/BuyerPropertyRequirements","description":"Property Requirements Model:-","readOnly":true}}},"buyerAlerts":{"description":"Buyer Alerts Model :-","type":"object","properties":{"SendMatchingProperties":{"description":"Send Matching Properties Alert:-","type":"boolean","readOnly":true},"EmailAlert":{"description":"Send Email Alert:-","type":"boolean","readOnly":true},"SMSAlert":{"format":"date-time","description":"Send SMS Alert:-","type":"string","readOnly":true},"PostAlert":{"description":"Send Post Alert:-","type":"boolean","readOnly":true}}},"BuyerPropertyRequirements":{"description":"Buyer Property Requirements:-","type":"object","properties":{"PositionToBuy":{"description":"Position to buy:-","enum":["Cash","FirstTimeBuyer","Mortgage","Investor","NeedsToSell","Company","Other","SSTC"],"type":"string","readOnly":true},"PurchaseReason":{"description":"Purchase Reason:-","enum":["Downsizing","Upsizing","ChangingArea","SecondHome","InvestmentProperty","Other","FirstTimeBuyer"],"type":"string","readOnly":true},"MortgateOffered":{"description":"Mortgate Offered:-","enum":["NoMortgageInPlace","AgreementInPrinciple","Other","NoMortageRequired"],"type":"string","readOnly":true},"SellingPosition":{"description":"Selling Position:-","enum":["PropertyOnMarket","PropertyNotOnMarket","PropertyUnderOffer","NoNeedToSell","Other"],"type":"string","readOnly":true},"MaximumPrice":{"format":"double","description":"Maxium Price:-","type":"number","readOnly":true},"MinBeds":{"format":"int32","description":"Min Bedrooms:-","type":"integer","readOnly":true},"MinReceptionRooms":{"format":"int32","description":"Min reception rooms:-","type":"integer","readOnly":true},"MinBathrooms":{"format":"int32","description":"Min Bathrooms:-","type":"integer","readOnly":true},"MinEnsuites":{"format":"int32","description":"Min Ensuites:-","type":"integer","readOnly":true},"MinToilets":{"format":"int32","description":"Min Toilets:-","type":"integer","readOnly":true},"MatchType":{"description":"Property Match Type:-","enum":["Houses","FlatApartments","Bungalows","Other"],"type":"string","readOnly":true},"MatchStyle":{"description":"Property Match Style:-","enum":["BarnConversion","Cottage","Challet","DetachedHouse","SemiDetachedHouse","LinkDetached","FarmHouse","ManorHouse","Mews","MidTerracedHouse","EndTerracedHouse","TownHouse","Villa","SharedHouse","ShelteredHousing","HouseFlatShare","GroundFloorFlat","DetachedBungalow","SemiDetachedBungalow","BuildingPlotLand","Apartment","Penthouse","Studio","MidTerracedBungalow","Block","House","FlatApartment","Bungalow","Land","GarageParking","CommercialProperty","ServicedApartment","LandResidential","ClusterHouse","GroundFlat","GroundMaisonette","Maisonette","Finca","RetirementProperty","FlatShare","Garages","Duplex","Triplex","VillageHouse","SemiDetachedVilla","DetachedVilla","HotelRoom","BlockOfApartments","PrivateHalls","MobileHome","CharacterProperty","HouseUnspecified","ParkHome","BarnStandAlone","Mill","Restaurant","Cafe","Castle","FarmLand","CountryHouse","BarNightClub","Shop","Office","BusinessPark","Hotel","Pub","Storage","Warehouse","ResidentialDevelopment","Farm","MixedUse","HouseofMultipleOccupation","LightIndustrial"],"type":"string","readOnly":true},"MatchLocation":{"description":"Property Match Location:-","enum":["Urban","Rural","Town","Village","Riverside","SeasideSeafront"],"type":"string","readOnly":true},"MinAcres":{"format":"int32","description":"Min Acres:-","type":"integer","readOnly":true},"OnlyDevelopments":{"description":"Only Developments:-","type":"boolean","readOnly":true},"OnlyInvestments":{"description":"Only Investments:-","type":"boolean","readOnly":true},"PriceRangeTo":{"format":"double","description":"Price Range To:-","type":"number","readOnly":true},"PriceRangeFrom":{"format":"double","description":"Price Range From:-","type":"number","readOnly":true}}},"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"}}},"TenancyApplicationWithAlertsDirect":{"description":"Tenancy Application with Alerts:-","type":"object","properties":{"Documents":{"description":"Documents","type":"array","items":{"$ref":"#/definitions/TenancyApplicationDocumentModel"}},"Applicant":{"$ref":"#/definitions/DirectApplicant","description":"Applicant details"}}},"TenancyApplicationDocumentModel":{"description":"Model to represent online tenancy application documents.","type":"object","properties":{"DocumentName":{"description":"Document name","type":"string"},"MimeType":{"description":"Mime type","type":"string"},"Contents":{"description":"Base64 string to convert to document","type":"string"}}},"DirectApplicant":{"description":"Helper Class – Store Applicant Details","type":"object","properties":{"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"Nationality":{"description":"Nationality","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string"},"MobilePhone":{"description":"Mobile Phone","type":"string"},"EmailAddress":{"description":"Email Addresses","type":"string"},"EmailAlerts":{"description":"Email Alerts","type":"boolean"},"SMSAlerts":{"description":"SMS Alerts","type":"boolean"},"MinRent":{"format":"double","description":"The Minimum Rent Value","type":"number"},"MaxRent":{"format":"double","description":"The Maximum Rent Value","type":"number"},"NumberOfBeds":{"format":"int32","description":"Number of Beds","type":"integer"},"RoomInSharedProperty":{"description":"Prospect Accept Shared Rooms?","type":"boolean"},"TenantType":{"description":"Tenant Type","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"AreaID":{"description":"Area ID","type":"string"},"GeneralNotes":{"description":"General Notes","type":"string"},"PropertyAddress":{"description":"Property Address","type":"string"},"UniversityNumber":{"description":"University Number","type":"string"},"Reference":{"description":"Reference details","type":"array","items":{"$ref":"#/definitions/Reference"}},"BankDetails":{"$ref":"#/definitions/BankDetails","description":"The applicant's bank details:-"}}},"Reference":{"description":"Helper Class – Store Applicant Reference Details","type":"object","properties":{"Type":{"description":"Reference Type","enum":["None","PermanentAddress","PreTenancyAddress","Employer","Guarantor","NextOfKin","Referee","Accountant","PensionAdministrator","PreTenancyAgent","PreTenancyLandlord","PostTenancyAddress","PostTenancyAgent","PostTenancyLandlord","RentDemandAddress","Organisation","College","Representative","ThirdPartyAuthority","Trustee","Administrator","SalesManager","PXManager"],"type":"string"},"OrganisationName":{"description":"Organisation Name","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Middlename":{"description":"Middlename","type":"string"},"Surname":{"description":"Surname","type":"string"},"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"},"Country":{"description":"Country","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string"},"LandPhone":{"description":"Land Phone","type":"string"},"MobilePhone":{"description":"Mobile Phone","type":"string"},"FaxPhone":{"description":"Fax Phone","type":"string"},"Email":{"description":"Email","type":"string"},"GeneralNotes":{"description":"General Notes","type":"string"},"ValidFrom":{"format":"date-time","description":"Valid From","type":"string"},"ValidTo":{"format":"date-time","description":"Valid To","type":"string"}}},"BankDetails":{"description":"Applicant bank details","type":"object","properties":{"BankName":{"description":"The name of the bank applicant has account with:-","type":"string"},"BankAddress1":{"description":"The first line of the bank's address:-","type":"string"},"BankAddress2":{"description":"The second line of the bank's address:-","type":"string"},"BankAddress3":{"description":"The third line of the bank's address:-","type":"string"},"BankAddress4":{"description":"The fourth line of the bank's address:-","type":"string"},"BankPostcode":{"description":"The bank's postcode:-","type":"string"},"AccountDetails":{"$ref":"#/definitions/AccountDetails","description":"The applicant's bank account details:-"}}},"AccountDetails":{"description":"The account details for an applicant's bank account:-","type":"object","properties":{"AccountNumber":{"description":"The applicant's account number:-","type":"string"},"SortCode":{"description":"The applicant's sort code:-","type":"string"},"AccountName":{"description":"The applicant's account name:-","type":"string"}}},"TenancyApplicationWithAlerts":{"description":"Tenancy Application with Alerts:-","type":"object","properties":{"Documents":{"description":"Documents","type":"array","items":{"$ref":"#/definitions/TenancyApplicationDocumentModel"}},"Applicant":{"$ref":"#/definitions/Applicant","description":"Applicant details"}}},"Applicant":{"description":"Helper Class – Store Applicant Details","type":"object","properties":{"TenancyRef":{"description":"Tenancy Reference","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Surname":{"description":"Surname","type":"string"},"DOB":{"format":"date-time","description":"Date of Birth","type":"string"},"Nationality":{"description":"Nationality","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string"},"MobilePhone":{"description":"Mobile Phone","type":"string"},"EmailAddress":{"description":"Email Addresses","type":"string"},"EmailLetters":{"description":"Email Letters","type":"boolean"},"EmailAlerts":{"description":"Email Alerts","type":"boolean"},"SMSAlerts":{"description":"SMS Alerts","type":"boolean"},"MinRent":{"format":"double","description":"The Minimum Rent Value","type":"number"},"MaxRent":{"format":"double","description":"The Maximum Rent Value","type":"number"},"NumberOfBeds":{"format":"int32","description":"Number of Beds","type":"integer"},"RoomInSharedProperty":{"description":"Prospect Accept Shared Rooms?","type":"boolean"},"TenantType":{"description":"Tenant Type","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"AreaID":{"description":"Area ID","type":"string"},"GeneralNotes":{"description":"General Notes","type":"string"},"PropertyAddress":{"description":"Property Address","type":"string"},"UniversityNumber":{"description":"University Number","type":"string"},"Reference":{"description":"Reference details","type":"array","items":{"$ref":"#/definitions/Reference"}},"Contact":{"description":"Contact details","type":"array","items":{"$ref":"#/definitions/Contact"}},"BankDetails":{"$ref":"#/definitions/BankDetails","description":"The applicant's bank details:-"}}},"Contact":{"description":"Helper Class – Store Applicant Contact Details","type":"object","properties":{"Type":{"description":"Contact Type","enum":["None","PermanentAddress","PreTenancyAddress","Employer","Guarantor","NextOfKin","Referee","Accountant","PensionAdministrator","PreTenancyAgent","PreTenancyLandlord","PostTenancyAddress","PostTenancyAgent","PostTenancyLandlord","RentDemandAddress","Organisation","College","Representative","ThirdPartyAuthority","Trustee","Administrator","SalesManager","PXManager"],"type":"string"},"OrganisationName":{"description":"Organisation Name","type":"string"},"Title":{"description":"Title","type":"string"},"Forename":{"description":"Forename","type":"string"},"Middlename":{"description":"Middlename","type":"string"},"Surname":{"description":"Surname","type":"string"},"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"},"Country":{"description":"Country","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","AntiguaAndBarbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","BosniaAndHerzegovina","Botswana","Brazil","Brunei","Bulgaria","BurkinaFaso","Burundi","Cambodia","Cameroon","Canada","CapeVerde","CentralAfricanRepublic","Chad","Chile","China","Colombia","Comoros","CongoBrazzaville","CongoDemocraticRepublicOfThe","CostaRica","CoteDIvoire","Croatia","Cuba","Cyprus","CzechRepublic","Denmark","Djibouti","Dominica","DominicanRepublic","EastTimorTimorTimur","Ecuador","Egypt","ElSalvador","EquatorialGuinea","Eritrea","Estonia","Ethiopia","Fiji","Finland","France","Gabon","GambiaThe","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","GuineaBissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","KoreaNorth","KoreaSouth","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","MacedoniaFormerYugoslavRepublicOf","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","MarshallIslands","Mauritania","Mauritius","Mexico","MicronesiaFederatedStatesOf","Moldova","Monaco","Mongolia","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","NewZealand","Nicaragua","Niger","Nigeria","Norway","Oman","Pakistan","Palau","Panama","PapuaNewGuinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","SaintKittsAndNevis","SaintLucia","SaintVincentAndTheGrenadines","Samoa","SanMarino","SaoTomeAndPrincipe","SaudiArabia","Senegal","SerbiaAndMontenegro","Seychelles","SierraLeone","Singapore","Slovakia","Slovenia","SolomonIslands","Somalia","SouthAfrica","Spain","SriLanka","Sudan","Suriname","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tonga","TrinidadAndTobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","UnitedArabEmirates","UnitedKingdom","UnitedStates","Uruguay","Uzbekistan","Vanuatu","VaticanCity","Venezuela","Vietnam","WesternSahara","Yemen","Zambia","Zimbabwe","UnknownCountry","HongKong","Jersey","ChannelIslands","Bermuda","BritishOverseasTerritory","Aruba","Kosovo","Macau"],"type":"string"},"LandPhone":{"description":"Land Phone","type":"string"},"MobilePhone":{"description":"Mobile Phone","type":"string"},"FaxPhone":{"description":"Fax Phone","type":"string"},"Email":{"description":"Email","type":"string"},"GeneralNotes":{"description":"General Notes","type":"string"},"ValidFrom":{"format":"date-time","description":"Valid From","type":"string"},"ValidTo":{"format":"date-time","description":"Valid To","type":"string"}}},"MatchingLettingsResultsModelResults":{"description":"Matching Letting Results Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/MatchingLettingsResultsModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"MatchingLettingsResultsModel":{"type":"object","properties":{"OID":{"description":"The Unique Tenancy OID:-","type":"string","readOnly":true},"TenancyAddress":{"$ref":"#/definitions/LettingsAddressHelper","description":"Tenancy Address Helper Model :-","readOnly":true},"Rent":{"format":"double","description":"Tenancy Advertised Rent:-","type":"number","readOnly":true},"RentRecurrence":{"format":"int32","description":"Tenancy Rent Recurrence:-","type":"integer","readOnly":true},"Bedrooms":{"format":"int32","description":"Tenancy Bedroom :-","type":"integer","readOnly":true},"TenantType":{"description":"Tenancy Acceptable Tenant Type:-","type":"array","items":{"enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"readOnly":true},"Furnished":{"description":"Tenancy Furnished Status :-","enum":["Unfurnished","PartFurnished","Furnished"],"type":"string","readOnly":true}}},"LettingsAddressHelper":{"type":"object","properties":{"AddressNumber":{"description":"Tenancy Address Number:-","type":"string","readOnly":true},"FlatRoomNumber":{"description":"Tenancy Flat/Room Number:-","type":"string","readOnly":true},"Address1":{"description":"Tenancy Address 1:-","type":"string","readOnly":true},"Address2":{"description":"Tenancy Address 2:-","type":"string","readOnly":true},"Address3":{"description":"Tenancy Address 3:-","type":"string","readOnly":true},"Address4":{"description":"Tenancy Address 4:-","type":"string","readOnly":true},"Postcode":{"description":"Tenancy Postcode:-","type":"string","readOnly":true}}},"MatchingSalesResultsModelResults":{"description":"Matching Sales Results Model Results Helper Model:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/MatchingSalesResultsModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"MatchingSalesResultsModel":{"type":"object","properties":{"OID":{"description":"The Unique Sales Instruction OID:-","type":"string","readOnly":true},"Address":{"$ref":"#/definitions/SalesAddressHelper","description":"Sales Address Helper Model :-","readOnly":true},"Price":{"format":"double","description":"Sales Asking Price:-","type":"number","readOnly":true},"Bedrooms":{"format":"int32","description":"Number of Bedrooms :-","type":"integer","readOnly":true},"ReceptionRooms":{"format":"int32","description":"Number of Reception Rooms:-","type":"integer","readOnly":true},"Bathrooms":{"format":"int32","description":"Number of Bathrooms :-","type":"integer","readOnly":true},"Ensuites":{"format":"int32","description":"Number of Ensuites:-","type":"integer","readOnly":true},"Toilets":{"format":"int32","description":"Number of Toilets","type":"integer","readOnly":true},"PropertyType":{"description":"Match Property Type:-","enum":["Houses","FlatApartments","Bungalows","Other"],"type":"string","readOnly":true},"PropertyStyle":{"description":"Match Property Style:-","enum":["BarnConversion","Cottage","Challet","DetachedHouse","SemiDetachedHouse","LinkDetached","FarmHouse","ManorHouse","Mews","MidTerracedHouse","EndTerracedHouse","TownHouse","Villa","SharedHouse","ShelteredHousing","HouseFlatShare","GroundFloorFlat","DetachedBungalow","SemiDetachedBungalow","BuildingPlotLand","Apartment","Penthouse","Studio","MidTerracedBungalow","Block","House","FlatApartment","Bungalow","Land","GarageParking","CommercialProperty","ServicedApartment","LandResidential","ClusterHouse","GroundFlat","GroundMaisonette","Maisonette","Finca","RetirementProperty","FlatShare","Garages","Duplex","Triplex","VillageHouse","SemiDetachedVilla","DetachedVilla","HotelRoom","BlockOfApartments","PrivateHalls","MobileHome","CharacterProperty","HouseUnspecified","ParkHome","BarnStandAlone","Mill","Restaurant","Cafe","Castle","FarmLand","CountryHouse","BarNightClub","Shop","Office","BusinessPark","Hotel","Pub","Storage","Warehouse","ResidentialDevelopment","Farm","MixedUse","HouseofMultipleOccupation","LightIndustrial"],"type":"string","readOnly":true},"PropertyLocation":{"description":"Match Property Location","enum":["Urban","Rural","Town","Village","Riverside","SeasideSeafront"],"type":"string","readOnly":true}}},"SalesAddressHelper":{"description":"Sales Address Helper Model","type":"object","properties":{"AddressNumber":{"description":"Sales Property Address Number:-","type":"string","readOnly":true},"Address1":{"description":"Sales Property Address 1:-","type":"string","readOnly":true},"Address2":{"description":"Sales Property Address 2:-","type":"string","readOnly":true},"Address3":{"description":"Sales Property Address 3:-","type":"string","readOnly":true},"Address4":{"description":"Sales Property Address 4:-","type":"string","readOnly":true},"Postcode":{"description":"Sales Property Postcode:-","type":"string","readOnly":true}}},"SalesOfferModel":{"type":"object","properties":{"OID":{"description":"Unique Offer ID","type":"string"},"ETag":{"description":"Offer ETag","type":"string"},"Amount":{"format":"double","description":"Offer amount","type":"number"},"FixturesFitting":{"description":"Offer Fixtures Fitting","type":"string"},"HowCloseToAsking":{"description":"How close offer is to asking price","type":"string"},"LinkedSalesInstructionOID":{"description":"The linked sales instruction for the offer","type":"string"},"NegotiatorOID":{"description":"The unique negotiator ID","type":"string"},"Notes":{"description":"Offer Notes","type":"string"},"OfferDate":{"description":"Offer Date","type":"string"},"LinkedBuyerOID":{"description":"The unique buyer ID for the offer","type":"string"},"SpecialTerms":{"description":"Special terms of the offer","type":"string"},"State":{"description":"State of the offer","enum":["Pending","Accepted","Declined","DeclinedOfferRevised","Withdrawn","AcceptedFallenThrough","ReferredToVendor"],"type":"string"},"SubjectTo":{"description":"Offer subject to","type":"string"},"SubjectToContract":{"description":"Offer subject to contract","type":"boolean"},"SubjectToMortgage":{"description":"Offer subject to mortgage","type":"boolean"},"SubjectToSurvey":{"description":"Offer subject to survey","type":"boolean"}}},"SalesOfferSubmissionModel":{"type":"object","properties":{"Amount":{"format":"double","description":"Offer amount","type":"number"},"DepositAmount":{"format":"int32","description":"Offer Amount Deposit:-","type":"integer"},"MortgageAmount":{"format":"int32","description":"Mortgage Amount:-","type":"integer"},"SpecialTerms":{"description":"Special Terms:-","type":"string"},"FixtureFittings":{"description":"Fixture Fittings:-","type":"string"},"SubjectToContract":{"description":"Deposit Amount:-","type":"boolean"},"SubjectToMortgage":{"description":"Offer subject to mortgage","type":"boolean"},"SubjectToSurvey":{"description":"Offer subject to survey","type":"boolean"}}},"ApplicantBuyerSubmissionModel":{"description":"Applicant Buyer Submission Model:-","type":"object","properties":{"Title":{"description":"Buyers Title:-","type":"string"},"Forename":{"description":"Buyers Forename:-","type":"string"},"Middlename":{"description":"Buyers Middle Name:-","type":"string"},"Surname":{"description":"Buyers Surname:-","type":"string"},"Email":{"description":"Buyers Email:-","type":"string"},"Mobile":{"description":"Buyers Mobile Number:-","type":"string"},"MaxPrice":{"format":"double","description":"Buyers Max Price:-","type":"number"},"MinimumBedrooms":{"format":"int32","description":"Buyers Minimum Bedrooms:-","type":"integer"},"MinimumReceptionRooms":{"format":"int32","description":"Buyers Minimum Reception Rooms:-","type":"integer"},"MinimumBathrooms":{"format":"int32","description":"Buyers Minimum Bathrooms","type":"integer"},"MinimumEnsuites":{"format":"int32","description":"Buyers Minimum Ensuites:-","type":"integer"},"MinimumToilets":{"format":"int32","description":"Buyers Minimum Toilets:-","type":"integer"},"SMSAlerts":{"description":"Enable SMS Alerts:-","type":"boolean"},"EmailAlerts":{"description":"Enable Email Alerts:-","type":"boolean"}}},"BaseStaffMemberResultsModel":{"description":"Base Staff Member Results Model:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/BaseStaffMemberModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"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"}}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}