{"swagger":"2.0","info":{"version":"v3-systemevents","title":"agentOS API V3, SystemEvents Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v3/systemevents/{shortName}/company/branches":{"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":"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/AdvertisingBranchModelResults"}}}}},"/v3/systemevents/{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/AdvertisingBranchModel"}}}}},"/v3/systemevents/{shortName}/contacts/branch/{branchID}":{"get":{"tags":["ContactsController"],"summary":"Get branch default email address","operationId":"ContactsController_GetBranchDefaultEmailAddress","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 branch ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemEventsBranchEmailModel"}}}}},"/v3/systemevents/{shortName}/createapplicant":{"post":{"tags":["EventController"],"summary":"Create a lettings Applicant linked to a branch","operationId":"EventController_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 short-name","required":true,"type":"string"},{"name":"branchID","in":"query","description":"The unique ID of the Branch","required":true,"type":"string"},{"name":"applicantData","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/SystemEventsCreateApplicantModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v3/systemevents/{shortName}/properties":{"get":{"tags":["PropertyController"],"summary":"search for advertised properties to link to tenancy applications:=","operationId":"PropertyController_SearchProperties","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PropertySearchResultModelResults"}}}}},"/v3/systemevents/{shortName}/submittenancyapplication":{"post":{"tags":["EventController"],"summary":"Submit an Online Tenancy Application to the In Tray","operationId":"EventController_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":"","required":true,"schema":{"$ref":"#/definitions/ThirdPartySubmitTenancyApplicationWithDocumentsModel"}},{"name":"documentType","in":"query","description":"The Document Type","required":false,"type":"string","enum":["Accountant","AntiMoneyLaunderingCheck","Bank","CollegeUniversity","CreditCheck","Employer","Guarantor","Identification","NextofKin","PensionAdministrator","PreTenancyAgent","PreTenancyLandlord","ProofofCurrentAddress","Referee","Other"]}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}}},"definitions":{"AdvertisingBranchModelResults":{"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/AdvertisingBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"}}},"AdvertisingBranchModel":{"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"}}},"SystemEventsBranchEmailModel":{"description":"Branch Email Model:-","type":"object","properties":{"OID":{"description":"Branch OID:-","type":"string","readOnly":true},"BranchDefaultEmailAddress":{"description":"Branch Default Email Address:-","type":"string","readOnly":true}}},"ThirdPartySubmitTenancyApplicationWithDocumentsModel":{"description":"Model to represent online tenancy applications submitted via the API. With additional document details\r\nThis model is designed to be converted into an XML file.","type":"object","properties":{"Documents":{"description":"Array of documents","type":"array","items":{"$ref":"#/definitions/TenancyApplicationDocumentModel"}},"Applicant":{"$ref":"#/definitions/Applicant","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"}}},"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"},"Middlename":{"description":"Middlename","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"},"TenantType":{"description":"Tenant Type","enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"},"GeneralNotes":{"description":"General Notes","type":"string"},"PropertyAddress":{"description":"Property Address","type":"string"},"UniversityNumber":{"description":"University Number","type":"string"},"Marketing":{"description":"Marketing","type":"boolean"},"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"}}},"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"}}},"SystemEventsCreateApplicantModel":{"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"},"RentRecurrence":{"format":"int32","description":"Rent Recurrence:-","type":"integer"},"RentSchedule":{"description":"Rent Schedule:-","enum":["Once","Daily","Weekly","Monthly","Yearly"],"type":"string"},"Notes":{"description":"Notes","type":"string"}}},"PropertySearchResultModelResults":{"description":"Property Search Results Model:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/PropertySearchResultModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"}}},"PropertySearchResultModel":{"description":"Property Search Result Model:-","type":"object","properties":{"OID":{"description":"OID:-","type":"string"},"GlobalReference":{"description":"Global Reference:-","type":"string"},"Description":{"description":"Description:-","type":"string"}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}