POST api/Applicant/{id}
Register Lettings Applicant
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
request | Pass through the Applicant Object and id=True |
Define this parameter in the request body. |
id | True if the applicant is a lettings applicant |
Define this parameter in the request URI. |
Request body formats
application/json, text/json
Sample:
{ "Address": { "BuildingName": "sample string 1", "Country": "sample string 2", "County": "sample string 3", "DependantLocality": "sample string 4", "Id": "sample string 5", "InternalAddres": true, "Latitude": 7.1, "Line1": "sample string 8", "Line2": "sample string 9", "Line3": "sample string 10", "Line4": "sample string 11", "Line5": "sample string 12", "Longitude": 13.1, "Postcode": "sample string 14", "PriamryKey": "sample string 15", "SubBuildingName": "sample string 16", "Town": "sample string 17" }, "Areas": [ { "DisplayValue": "sample string 1", "Id": "sample string 2" }, { "DisplayValue": "sample string 1", "Id": "sample string 2" }, { "DisplayValue": "sample string 1", "Id": "sample string 2" } ], "Bedrooms": 1, "Branch": { "DisplayValue": "sample string 1", "Id": "sample string 2" }, "Children": true, "CompanyName": "sample string 2", "Email": "sample string 3", "FirstName": "sample string 4", "Furnished": { "DisplayValue": "sample string 1", "Id": "sample string 2" }, "Id": "sample string 5", "Individual": true, "IsMonthly": true, "LastName": "sample string 7", "MaxBudget": 8.1, "MinBudget": 9.1, "MoveInDate": "2024-09-08T01:31:32.7115673+01:00", "Occupation": "sample string 11", "PetType": "sample string 12", "Pets": true, "Prefix": true, "PropertyType": { "DisplayValue": "sample string 1", "Id": "sample string 2" }, "ReasonForMoving": { "DisplayValue": "sample string 1", "Id": "sample string 2" }, "Reference": "sample string 13", "ResponsibilityOf": "sample string 14", "Smoke": true, "Special": "sample string 15", "Telephone": "sample string 16", "Title": { "DisplayValue": "sample string 1", "Id": "sample string 2" } }
application/xml, text/xml
Sample:
<LettingsApplicant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VecoSoap.Data"> <Address> <BuildingName>sample string 1</BuildingName> <Country>sample string 2</Country> <County>sample string 3</County> <DependantLocality>sample string 4</DependantLocality> <Id>sample string 5</Id> <InternalAddres>true</InternalAddres> <Latitude>7.1</Latitude> <Line1>sample string 8</Line1> <Line2>sample string 9</Line2> <Line3>sample string 10</Line3> <Line4>sample string 11</Line4> <Line5>sample string 12</Line5> <Longitude>13.1</Longitude> <Postcode>sample string 14</Postcode> <PriamryKey>sample string 15</PriamryKey> <SubBuildingName>sample string 16</SubBuildingName> <Town>sample string 17</Town> </Address> <Areas> <Area> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Area> <Area> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Area> <Area> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Area> </Areas> <Bedrooms>1</Bedrooms> <Branch> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Branch> <Children>true</Children> <CompanyName>sample string 2</CompanyName> <Email>sample string 3</Email> <FirstName>sample string 4</FirstName> <Furnished> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Furnished> <Id>sample string 5</Id> <Individual>true</Individual> <IsMonthly>true</IsMonthly> <LastName>sample string 7</LastName> <MaxBudget>8.1</MaxBudget> <MinBudget>9.1</MinBudget> <MoveInDate>2024-09-08T01:31:32.7115673+01:00</MoveInDate> <Occupation>sample string 11</Occupation> <PetType>sample string 12</PetType> <Pets>true</Pets> <Prefix>true</Prefix> <PropertyType> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </PropertyType> <ReasonForMoving> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </ReasonForMoving> <Reference>sample string 13</Reference> <ResponsibilityOf>sample string 14</ResponsibilityOf> <Smoke>true</Smoke> <Special>sample string 15</Special> <Telephone>sample string 16</Telephone> <Title> <DisplayValue>sample string 1</DisplayValue> <Id>sample string 2</Id> </Title> </LettingsApplicant>
application/x-www-form-urlencoded
Sample:
Sample not available.