PUT 17.0/database/properties/{id}

Description

Update existing Properties

URI Parameters

Name Description Type Additional information
id

integer

Required

Name Description Type Additional information
LeaseYears

integer

None.

ID

integer

None.

Description

string

String length: inclusive between 0 and 300

FullDescription

string

None.

BulletPoints

string

None.

Notes

string

None.

ContactID

integer

None.

UserID

integer

None.

AssistedByUserID

integer

None.

SiteID

integer

None.

CompanyID

integer

None.

BlockManagementCompanyID

integer

None.

AltReference

string

String length: inclusive between 0 and 50

Status

byte

None.

StatusDate

date

None.

Category

byte

None.

Tenure

byte

None.

Type

byte

None.

SellingMethod

byte

None.

DisplayAddress

string

String length: inclusive between 0 and 120

CountryCode

integer

None.

PropertyName

string

String length: inclusive between 0 and 50

Street

string

String length: inclusive between 0 and 50

Locality

string

String length: inclusive between 0 and 30

Town

string

String length: inclusive between 0 and 30

Region

string

String length: inclusive between 0 and 30

Postcode

string

String length: inclusive between 0 and 30

Country

string

String length: inclusive between 0 and 30

PropertyLocalAuthorityID

integer

None.

PropertyTaxBandID

integer

None.

PricePrefix

byte

None.

Price

decimal number

None.

PriceMatch

decimal number

None.

PriceFrequency

byte

None.

ValuationPrice

decimal number

None.

PotentialAnnualRent

decimal number

None.

Deposit

decimal number

None.

CurrencyID

integer

None.

AddedDate

date

None.

UpdatedDateTime

date

None.

MarketDate

date

None.

ExpiryDate

date

None.

AgencyType

byte

None.

IntroductionFee

decimal number

None.

IntroductionPercentage

decimal number

None.

CommissionFee

decimal number

None.

CommissionPercentage

decimal number

None.

PaymentCycleID

integer

None.

DetailsFileName

string

None.

PicturesHighRes

string

None.

Pictures

string

None.

PictureWebMain

byte

None.

FloorPlanFileNameWeb

string

String length: inclusive between 0 and 255

FloorPlanFileNamePrint

string

String length: inclusive between 0 and 255

Directions

string

None.

Built

integer

None.

NewHome

byte

None.

ExclusiveHome

byte

None.

Age

byte

None.

Bedrooms

byte

None.

PermittedOccupiers

byte

None.

Bathrooms

byte

None.

ReceptionRooms

byte

None.

Gardens

byte

None.

Land

byte

None.

Lift

byte

None.

Garage

byte

None.

ParkingOffStreet

integer

None.

DoubleGlazing

byte

None.

CentralHeating

byte

None.

OpenFireStove

byte

None.

Gas

byte

None.

Electric

byte

None.

Water

byte

None.

Drainage

byte

None.

Telephone

byte

None.

Cable

byte

None.

OtherServices

string

String length: inclusive between 0 and 255

RentalAvailableDate

date

None.

RentalTerms

byte

None.

RentalMinimumTerm

integer

None.

RentalBenefit

byte

None.

RentalPets

byte

None.

RentalIncludesBills

byte

None.

RentalFurnished

byte

None.

RentalChildren

byte

None.

RentalStudents

byte

None.

RentalHMO

byte

None.

RentalSmokers

byte

None.

RentalManagementType

byte

None.

ManagementTypeID

integer

None.

ViewingArrangements

integer

None.

ViewingNotes

string

None.

PropertyAreaID

integer

None.

Board

integer

None.

UtilitySupplierGasID

integer

None.

UtilitySupplierElectricityID

integer

None.

UtilitySupplierWaterID

integer

None.

UtilitySupplierTelephoneID

integer

None.

UtilitySupplierCableID

integer

None.

UtilitySupplierDrainageID

integer

None.

UtilitySupplierGasRef

string

String length: inclusive between 0 and 50

UtilitySupplierElectricityRef

string

String length: inclusive between 0 and 50

UtilitySupplierWaterRef

string

String length: inclusive between 0 and 50

UtilitySupplierTelephoneRef

string

String length: inclusive between 0 and 50

UtilitySupplierCableRef

string

String length: inclusive between 0 and 50

UtilitySupplierDrainageRef

string

String length: inclusive between 0 and 50

ForceWebUpload

byte

None.

SalesProgressorID

integer

None.

SolicitorID

integer

None.

PropertyDevelopmentID

integer

None.

VirtualTourURL

string

String length: inclusive between 0 and 255

VirtualTourURL2

string

String length: inclusive between 0 and 255

AdvertDescription

string

String length: inclusive between 0 and 500

WebFeatured

byte

None.

GroundRent

decimal number

None.

GroundRentFrequency

byte

None.

ServiceCharge

decimal number

None.

ServiceChargeFrequency

byte

None.

DisabledAccess

byte

None.

Retirement

byte

None.

DevelopmentPotential

byte

None.

InvestmentPotential

byte

None.

RequiresUpdating

byte

None.

Riverside

byte

None.

Seaside

byte

None.

FirstTimeBuyersOnly

byte

None.

LeisureFacilities

byte

None.

LeaseExpiryDate

date

None.

FloorArea

decimal number

None.

LandArea

decimal number

None.

Floor

byte

None.

SoldPrice

decimal number

None.

MortgageAmount

decimal number

None.

DepositAmount

decimal number

None.

ManagingAgentID

integer

None.

EPCNotRequired

byte

None.

UploadPDF

byte

None.

DisinstructionTypeID

integer

None.

Longitude

decimal number

None.

Latitude

decimal number

None.

MapZoomLevel

byte

None.

SuppressStreetView

byte

None.

StreetViewHeading

integer

None.

Qualification

byte

None.

ShortCode

integer

None.

PropertyChainID

integer

None.

Float

decimal number

None.

LonRes

byte

None.

CommissionSplit

decimal number

None.

UseClass

byte

None.

ContactBankID

integer

None.

FloorAreaMin

decimal number

None.

Usage

byte

None.

FloorAreaPrice

decimal number

None.

PrimaryProperty

byte

None.

LinkedTo

integer

None.

LettingFees

string

String length: inclusive between 0 and 4000

DetailsSent

byte

None.

OccupierID

integer

None.

GasPrePayment

byte

None.

ElectricityPrePayment

byte

None.

ElectricityEconomy7

byte

None.

ProgressionManagedBy

byte

None.

ViewingsManagedBy

byte

None.

ClientLoginUpdated

byte

None.

WebUploadSummary

byte

None.

ApplicantMatchingType

byte

None.

UploadPictures

byte

None.

LocalPropertyTaxNumber

string

String length: inclusive between 0 and 30

UniqueReferenceNumber

string

String length: inclusive between 0 and 30

What3Words

string

String length: inclusive between 0 and 100

CouncilTaxRate

decimal number

None.

CouncilTaxRateExpiryDate

date

None.

SharedOwnershipPercentage

byte

None.

SharedOwnershipRent

decimal number

None.

SharedOwnershipFrequency

byte

None.

ElectricMeterType

byte

None.

ElectricDisabled

byte

None.

GasMeterType

byte

None.

GasDisabled

byte

None.

WatermarkRequired

byte

None.

application/json, text/json

Sample:
{
  "leaseYears": 1,
  "id": 1,
  "description": "sample string 1",
  "fullDescription": "sample string 2",
  "bulletPoints": "sample string 3",
  "notes": "sample string 4",
  "contactID": 1,
  "userID": 1,
  "assistedByUserID": 1,
  "siteID": 1,
  "companyID": 1,
  "blockManagementCompanyID": 1,
  "altReference": "sample string 5",
  "status": 64,
  "statusDate": "2025-01-09T20:28",
  "category": 64,
  "tenure": 64,
  "type": 64,
  "sellingMethod": 64,
  "displayAddress": "sample string 6",
  "countryCode": 1,
  "propertyName": "sample string 7",
  "street": "sample string 8",
  "locality": "sample string 9",
  "town": "sample string 10",
  "region": "sample string 11",
  "postcode": "sample string 12",
  "country": "sample string 13",
  "propertyLocalAuthorityID": 1,
  "propertyTaxBandID": 1,
  "pricePrefix": 64,
  "price": 1.0,
  "priceMatch": 1.0,
  "priceFrequency": 64,
  "valuationPrice": 1.0,
  "potentialAnnualRent": 1.0,
  "deposit": 1.0,
  "currencyID": 1,
  "addedDate": "2025-01-09T20:28",
  "updatedDateTime": "2025-01-09T20:28",
  "marketDate": "2025-01-09T20:28",
  "expiryDate": "2025-01-09T20:28",
  "agencyType": 64,
  "introductionFee": 1.0,
  "introductionPercentage": 1.0,
  "commissionFee": 1.0,
  "commissionPercentage": 1.0,
  "paymentCycleID": 1,
  "detailsFileName": "sample string 14",
  "picturesHighRes": "sample string 15",
  "pictures": "sample string 16",
  "pictureWebMain": 64,
  "floorPlanFileNameWeb": "sample string 17",
  "floorPlanFileNamePrint": "sample string 18",
  "directions": "sample string 19",
  "built": 1,
  "newHome": 64,
  "exclusiveHome": 64,
  "age": 64,
  "bedrooms": 64,
  "permittedOccupiers": 64,
  "bathrooms": 64,
  "receptionRooms": 64,
  "gardens": 64,
  "land": 64,
  "lift": 64,
  "garage": 64,
  "parkingOffStreet": 1,
  "doubleGlazing": 64,
  "centralHeating": 64,
  "openFireStove": 64,
  "gas": 64,
  "electric": 64,
  "water": 64,
  "drainage": 64,
  "telephone": 64,
  "cable": 64,
  "otherServices": "sample string 20",
  "rentalAvailableDate": "2025-01-09T20:28",
  "rentalTerms": 64,
  "rentalMinimumTerm": 1,
  "rentalBenefit": 64,
  "rentalPets": 64,
  "rentalIncludesBills": 64,
  "rentalFurnished": 64,
  "rentalChildren": 64,
  "rentalStudents": 64,
  "rentalHMO": 64,
  "rentalSmokers": 64,
  "rentalManagementType": 64,
  "managementTypeID": 1,
  "viewingArrangements": 1,
  "viewingNotes": "sample string 21",
  "propertyAreaID": 1,
  "board": 1,
  "utilitySupplierGasID": 1,
  "utilitySupplierElectricityID": 1,
  "utilitySupplierWaterID": 1,
  "utilitySupplierTelephoneID": 1,
  "utilitySupplierCableID": 1,
  "utilitySupplierDrainageID": 1,
  "utilitySupplierGasRef": "sample string 22",
  "utilitySupplierElectricityRef": "sample string 23",
  "utilitySupplierWaterRef": "sample string 24",
  "utilitySupplierTelephoneRef": "sample string 25",
  "utilitySupplierCableRef": "sample string 26",
  "utilitySupplierDrainageRef": "sample string 27",
  "forceWebUpload": 64,
  "salesProgressorID": 1,
  "solicitorID": 1,
  "propertyDevelopmentID": 1,
  "virtualTourURL": "sample string 28",
  "virtualTourURL2": "sample string 29",
  "advertDescription": "sample string 30",
  "webFeatured": 64,
  "groundRent": 1.0,
  "groundRentFrequency": 64,
  "serviceCharge": 1.0,
  "serviceChargeFrequency": 64,
  "disabledAccess": 64,
  "retirement": 64,
  "developmentPotential": 64,
  "investmentPotential": 64,
  "requiresUpdating": 64,
  "riverside": 64,
  "seaside": 64,
  "firstTimeBuyersOnly": 64,
  "leisureFacilities": 64,
  "leaseExpiryDate": "2025-01-09T20:28",
  "floorArea": 1.0,
  "landArea": 1.0,
  "floor": 64,
  "soldPrice": 1.0,
  "mortgageAmount": 1.0,
  "depositAmount": 1.0,
  "managingAgentID": 1,
  "epcNotRequired": 64,
  "uploadPDF": 64,
  "disinstructionTypeID": 1,
  "longitude": 1.0,
  "latitude": 1.0,
  "mapZoomLevel": 64,
  "suppressStreetView": 64,
  "streetViewHeading": 1,
  "qualification": 64,
  "shortCode": 1,
  "propertyChainID": 1,
  "float": 1.0,
  "lonRes": 64,
  "commissionSplit": 1.0,
  "useClass": 64,
  "contactBankID": 1,
  "floorAreaMin": 1.0,
  "usage": 64,
  "floorAreaPrice": 1.0,
  "primaryProperty": 64,
  "linkedTo": 1,
  "lettingFees": "sample string 31",
  "detailsSent": 64,
  "occupierID": 1,
  "gasPrePayment": 64,
  "electricityPrePayment": 64,
  "electricityEconomy7": 64,
  "progressionManagedBy": 64,
  "viewingsManagedBy": 64,
  "clientLoginUpdated": 64,
  "webUploadSummary": 64,
  "applicantMatchingType": 64,
  "uploadPictures": 64,
  "localPropertyTaxNumber": "sample string 32",
  "uniqueReferenceNumber": "sample string 33",
  "what3Words": "sample string 34",
  "councilTaxRate": 1.0,
  "councilTaxRateExpiryDate": "2025-01-09T20:28",
  "sharedOwnershipPercentage": 64,
  "sharedOwnershipRent": 1.0,
  "sharedOwnershipFrequency": 64,
  "electricMeterType": 64,
  "electricDisabled": 64,
  "gasMeterType": 64,
  "gasDisabled": 64,
  "watermarkRequired": 64
}

application/xml, text/xml

Sample:
<PropertiesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LeaseYears>1</LeaseYears>
  <ID>1</ID>
  <Description>sample string 1</Description>
  <FullDescription>sample string 2</FullDescription>
  <BulletPoints>sample string 3</BulletPoints>
  <Notes>sample string 4</Notes>
  <ContactID>1</ContactID>
  <UserID>1</UserID>
  <AssistedByUserID>1</AssistedByUserID>
  <SiteID>1</SiteID>
  <CompanyID>1</CompanyID>
  <BlockManagementCompanyID>1</BlockManagementCompanyID>
  <AltReference>sample string 5</AltReference>
  <Status>64</Status>
  <StatusDate>2025-01-09T20:28:48.7142578+00:00</StatusDate>
  <Category>64</Category>
  <Tenure>64</Tenure>
  <Type>64</Type>
  <SellingMethod>64</SellingMethod>
  <DisplayAddress>sample string 6</DisplayAddress>
  <CountryCode>1</CountryCode>
  <PropertyName>sample string 7</PropertyName>
  <Street>sample string 8</Street>
  <Locality>sample string 9</Locality>
  <Town>sample string 10</Town>
  <Region>sample string 11</Region>
  <Postcode>sample string 12</Postcode>
  <Country>sample string 13</Country>
  <PropertyLocalAuthorityID>1</PropertyLocalAuthorityID>
  <PropertyTaxBandID>1</PropertyTaxBandID>
  <PricePrefix>64</PricePrefix>
  <Price>1</Price>
  <PriceMatch>1</PriceMatch>
  <PriceFrequency>64</PriceFrequency>
  <ValuationPrice>1</ValuationPrice>
  <PotentialAnnualRent>1</PotentialAnnualRent>
  <Deposit>1</Deposit>
  <CurrencyID>1</CurrencyID>
  <AddedDate>2025-01-09T20:28:48.7142578+00:00</AddedDate>
  <UpdatedDateTime>2025-01-09T20:28:48.7142578+00:00</UpdatedDateTime>
  <MarketDate>2025-01-09T20:28:48.7142578+00:00</MarketDate>
  <ExpiryDate>2025-01-09T20:28:48.7142578+00:00</ExpiryDate>
  <AgencyType>64</AgencyType>
  <IntroductionFee>1</IntroductionFee>
  <IntroductionPercentage>1</IntroductionPercentage>
  <CommissionFee>1</CommissionFee>
  <CommissionPercentage>1</CommissionPercentage>
  <PaymentCycleID>1</PaymentCycleID>
  <DetailsFileName>sample string 14</DetailsFileName>
  <PicturesHighRes>sample string 15</PicturesHighRes>
  <Pictures>sample string 16</Pictures>
  <PictureWebMain>64</PictureWebMain>
  <FloorPlanFileNameWeb>sample string 17</FloorPlanFileNameWeb>
  <FloorPlanFileNamePrint>sample string 18</FloorPlanFileNamePrint>
  <Directions>sample string 19</Directions>
  <Built>1</Built>
  <NewHome>64</NewHome>
  <ExclusiveHome>64</ExclusiveHome>
  <Age>64</Age>
  <Bedrooms>64</Bedrooms>
  <PermittedOccupiers>64</PermittedOccupiers>
  <Bathrooms>64</Bathrooms>
  <ReceptionRooms>64</ReceptionRooms>
  <Gardens>64</Gardens>
  <Land>64</Land>
  <Lift>64</Lift>
  <Garage>64</Garage>
  <ParkingOffStreet>1</ParkingOffStreet>
  <DoubleGlazing>64</DoubleGlazing>
  <CentralHeating>64</CentralHeating>
  <OpenFireStove>64</OpenFireStove>
  <Gas>64</Gas>
  <Electric>64</Electric>
  <Water>64</Water>
  <Drainage>64</Drainage>
  <Telephone>64</Telephone>
  <Cable>64</Cable>
  <OtherServices>sample string 20</OtherServices>
  <RentalAvailableDate>2025-01-09T20:28:48.7142578+00:00</RentalAvailableDate>
  <RentalTerms>64</RentalTerms>
  <RentalMinimumTerm>1</RentalMinimumTerm>
  <RentalBenefit>64</RentalBenefit>
  <RentalPets>64</RentalPets>
  <RentalIncludesBills>64</RentalIncludesBills>
  <RentalFurnished>64</RentalFurnished>
  <RentalChildren>64</RentalChildren>
  <RentalStudents>64</RentalStudents>
  <RentalHMO>64</RentalHMO>
  <RentalSmokers>64</RentalSmokers>
  <RentalManagementType>64</RentalManagementType>
  <ManagementTypeID>1</ManagementTypeID>
  <ViewingArrangements>1</ViewingArrangements>
  <ViewingNotes>sample string 21</ViewingNotes>
  <PropertyAreaID>1</PropertyAreaID>
  <Board>1</Board>
  <UtilitySupplierGasID>1</UtilitySupplierGasID>
  <UtilitySupplierElectricityID>1</UtilitySupplierElectricityID>
  <UtilitySupplierWaterID>1</UtilitySupplierWaterID>
  <UtilitySupplierTelephoneID>1</UtilitySupplierTelephoneID>
  <UtilitySupplierCableID>1</UtilitySupplierCableID>
  <UtilitySupplierDrainageID>1</UtilitySupplierDrainageID>
  <UtilitySupplierGasRef>sample string 22</UtilitySupplierGasRef>
  <UtilitySupplierElectricityRef>sample string 23</UtilitySupplierElectricityRef>
  <UtilitySupplierWaterRef>sample string 24</UtilitySupplierWaterRef>
  <UtilitySupplierTelephoneRef>sample string 25</UtilitySupplierTelephoneRef>
  <UtilitySupplierCableRef>sample string 26</UtilitySupplierCableRef>
  <UtilitySupplierDrainageRef>sample string 27</UtilitySupplierDrainageRef>
  <ForceWebUpload>64</ForceWebUpload>
  <SalesProgressorID>1</SalesProgressorID>
  <SolicitorID>1</SolicitorID>
  <PropertyDevelopmentID>1</PropertyDevelopmentID>
  <VirtualTourURL>sample string 28</VirtualTourURL>
  <VirtualTourURL2>sample string 29</VirtualTourURL2>
  <AdvertDescription>sample string 30</AdvertDescription>
  <WebFeatured>64</WebFeatured>
  <GroundRent>1</GroundRent>
  <GroundRentFrequency>64</GroundRentFrequency>
  <ServiceCharge>1</ServiceCharge>
  <ServiceChargeFrequency>64</ServiceChargeFrequency>
  <DisabledAccess>64</DisabledAccess>
  <Retirement>64</Retirement>
  <DevelopmentPotential>64</DevelopmentPotential>
  <InvestmentPotential>64</InvestmentPotential>
  <RequiresUpdating>64</RequiresUpdating>
  <Riverside>64</Riverside>
  <Seaside>64</Seaside>
  <FirstTimeBuyersOnly>64</FirstTimeBuyersOnly>
  <LeisureFacilities>64</LeisureFacilities>
  <LeaseExpiryDate>2025-01-09T20:28:48.72988+00:00</LeaseExpiryDate>
  <FloorArea>1</FloorArea>
  <LandArea>1</LandArea>
  <Floor>64</Floor>
  <SoldPrice>1</SoldPrice>
  <MortgageAmount>1</MortgageAmount>
  <DepositAmount>1</DepositAmount>
  <ManagingAgentID>1</ManagingAgentID>
  <EPCNotRequired>64</EPCNotRequired>
  <UploadPDF>64</UploadPDF>
  <DisinstructionTypeID>1</DisinstructionTypeID>
  <Longitude>1</Longitude>
  <Latitude>1</Latitude>
  <MapZoomLevel>64</MapZoomLevel>
  <SuppressStreetView>64</SuppressStreetView>
  <StreetViewHeading>1</StreetViewHeading>
  <Qualification>64</Qualification>
  <ShortCode>1</ShortCode>
  <PropertyChainID>1</PropertyChainID>
  <Float>1</Float>
  <LonRes>64</LonRes>
  <CommissionSplit>1</CommissionSplit>
  <UseClass>64</UseClass>
  <ContactBankID>1</ContactBankID>
  <FloorAreaMin>1</FloorAreaMin>
  <Usage>64</Usage>
  <FloorAreaPrice>1</FloorAreaPrice>
  <PrimaryProperty>64</PrimaryProperty>
  <LinkedTo>1</LinkedTo>
  <LettingFees>sample string 31</LettingFees>
  <DetailsSent>64</DetailsSent>
  <OccupierID>1</OccupierID>
  <GasPrePayment>64</GasPrePayment>
  <ElectricityPrePayment>64</ElectricityPrePayment>
  <ElectricityEconomy7>64</ElectricityEconomy7>
  <ProgressionManagedBy>64</ProgressionManagedBy>
  <ViewingsManagedBy>64</ViewingsManagedBy>
  <ClientLoginUpdated>64</ClientLoginUpdated>
  <WebUploadSummary>64</WebUploadSummary>
  <ApplicantMatchingType>64</ApplicantMatchingType>
  <UploadPictures>64</UploadPictures>
  <LocalPropertyTaxNumber>sample string 32</LocalPropertyTaxNumber>
  <UniqueReferenceNumber>sample string 33</UniqueReferenceNumber>
  <What3Words>sample string 34</What3Words>
  <CouncilTaxRate>1</CouncilTaxRate>
  <CouncilTaxRateExpiryDate>2025-01-09T20:28:48.72988+00:00</CouncilTaxRateExpiryDate>
  <SharedOwnershipPercentage>64</SharedOwnershipPercentage>
  <SharedOwnershipRent>1</SharedOwnershipRent>
  <SharedOwnershipFrequency>64</SharedOwnershipFrequency>
  <ElectricMeterType>64</ElectricMeterType>
  <ElectricDisabled>64</ElectricDisabled>
  <GasMeterType>64</GasMeterType>
  <GasDisabled>64</GasDisabled>
  <WatermarkRequired>64</WatermarkRequired>
</PropertiesUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Name Description Type Additional information
LeaseYears

integer

None.

ID

integer

None.

Description

string

String length: inclusive between 0 and 300

FullDescription

string

None.

BulletPoints

string

None.

Notes

string

None.

ContactID

integer

None.

UserID

integer

None.

AssistedByUserID

integer

None.

SiteID

integer

None.

CompanyID

integer

None.

BlockManagementCompanyID

integer

None.

AltReference

string

String length: inclusive between 0 and 50

Status

byte

None.

StatusDate

date

None.

Category

byte

None.

Tenure

byte

None.

Type

byte

None.

SellingMethod

byte

None.

DisplayAddress

string

String length: inclusive between 0 and 120

CountryCode

integer

None.

PropertyName

string

String length: inclusive between 0 and 50

Street

string

String length: inclusive between 0 and 50

Locality

string

String length: inclusive between 0 and 30

Town

string

String length: inclusive between 0 and 30

Region

string

String length: inclusive between 0 and 30

Postcode

string

String length: inclusive between 0 and 30

Country

string

String length: inclusive between 0 and 30

PropertyLocalAuthorityID

integer

None.

PropertyTaxBandID

integer

None.

PricePrefix

byte

None.

Price

decimal number

None.

PriceMatch

decimal number

None.

PriceFrequency

byte

None.

ValuationPrice

decimal number

None.

PotentialAnnualRent

decimal number

None.

Deposit

decimal number

None.

CurrencyID

integer

None.

AddedDate

date

None.

UpdatedDateTime

date

None.

MarketDate

date

None.

ExpiryDate

date

None.

AgencyType

byte

None.

IntroductionFee

decimal number

None.

IntroductionPercentage

decimal number

None.

CommissionFee

decimal number

None.

CommissionPercentage

decimal number

None.

PaymentCycleID

integer

None.

DetailsFileName

string

None.

PicturesHighRes

string

None.

Pictures

string

None.

PictureWebMain

byte

None.

FloorPlanFileNameWeb

string

String length: inclusive between 0 and 255

FloorPlanFileNamePrint

string

String length: inclusive between 0 and 255

Directions

string

None.

Built

integer

None.

NewHome

byte

None.

ExclusiveHome

byte

None.

Age

byte

None.

Bedrooms

byte

None.

PermittedOccupiers

byte

None.

Bathrooms

byte

None.

ReceptionRooms

byte

None.

Gardens

byte

None.

Land

byte

None.

Lift

byte

None.

Garage

byte

None.

ParkingOffStreet

integer

None.

DoubleGlazing

byte

None.

CentralHeating

byte

None.

OpenFireStove

byte

None.

Gas

byte

None.

Electric

byte

None.

Water

byte

None.

Drainage

byte

None.

Telephone

byte

None.

Cable

byte

None.

OtherServices

string

String length: inclusive between 0 and 255

RentalAvailableDate

date

None.

RentalTerms

byte

None.

RentalMinimumTerm

integer

None.

RentalBenefit

byte

None.

RentalPets

byte

None.

RentalIncludesBills

byte

None.

RentalFurnished

byte

None.

RentalChildren

byte

None.

RentalStudents

byte

None.

RentalHMO

byte

None.

RentalSmokers

byte

None.

RentalManagementType

byte

None.

ManagementTypeID

integer

None.

ViewingArrangements

integer

None.

ViewingNotes

string

None.

PropertyAreaID

integer

None.

Board

integer

None.

UtilitySupplierGasID

integer

None.

UtilitySupplierElectricityID

integer

None.

UtilitySupplierWaterID

integer

None.

UtilitySupplierTelephoneID

integer

None.

UtilitySupplierCableID

integer

None.

UtilitySupplierDrainageID

integer

None.

UtilitySupplierGasRef

string

String length: inclusive between 0 and 50

UtilitySupplierElectricityRef

string

String length: inclusive between 0 and 50

UtilitySupplierWaterRef

string

String length: inclusive between 0 and 50

UtilitySupplierTelephoneRef

string

String length: inclusive between 0 and 50

UtilitySupplierCableRef

string

String length: inclusive between 0 and 50

UtilitySupplierDrainageRef

string

String length: inclusive between 0 and 50

ForceWebUpload

byte

None.

SalesProgressorID

integer

None.

SolicitorID

integer

None.

PropertyDevelopmentID

integer

None.

VirtualTourURL

string

String length: inclusive between 0 and 255

VirtualTourURL2

string

String length: inclusive between 0 and 255

AdvertDescription

string

String length: inclusive between 0 and 500

WebFeatured

byte

None.

GroundRent

decimal number

None.

GroundRentFrequency

byte

None.

ServiceCharge

decimal number

None.

ServiceChargeFrequency

byte

None.

DisabledAccess

byte

None.

Retirement

byte

None.

DevelopmentPotential

byte

None.

InvestmentPotential

byte

None.

RequiresUpdating

byte

None.

Riverside

byte

None.

Seaside

byte

None.

FirstTimeBuyersOnly

byte

None.

LeisureFacilities

byte

None.

LeaseExpiryDate

date

None.

FloorArea

decimal number

None.

LandArea

decimal number

None.

Floor

byte

None.

SoldPrice

decimal number

None.

MortgageAmount

decimal number

None.

DepositAmount

decimal number

None.

ManagingAgentID

integer

None.

EPCNotRequired

byte

None.

UploadPDF

byte

None.

DisinstructionTypeID

integer

None.

Longitude

decimal number

None.

Latitude

decimal number

None.

MapZoomLevel

byte

None.

SuppressStreetView

byte

None.

StreetViewHeading

integer

None.

Qualification

byte

None.

ShortCode

integer

None.

PropertyChainID

integer

None.

Float

decimal number

None.

LonRes

byte

None.

CommissionSplit

decimal number

None.

UseClass

byte

None.

ContactBankID

integer

None.

FloorAreaMin

decimal number

None.

Usage

byte

None.

FloorAreaPrice

decimal number

None.

PrimaryProperty

byte

None.

LinkedTo

integer

None.

LettingFees

string

String length: inclusive between 0 and 4000

DetailsSent

byte

None.

OccupierID

integer

None.

GasPrePayment

byte

None.

ElectricityPrePayment

byte

None.

ElectricityEconomy7

byte

None.

ProgressionManagedBy

byte

None.

ViewingsManagedBy

byte

None.

ClientLoginUpdated

byte

None.

WebUploadSummary

byte

None.

ApplicantMatchingType

byte

None.

UploadPictures

byte

None.

LocalPropertyTaxNumber

string

String length: inclusive between 0 and 30

UniqueReferenceNumber

string

String length: inclusive between 0 and 30

What3Words

string

String length: inclusive between 0 and 100

CouncilTaxRate

decimal number

None.

CouncilTaxRateExpiryDate

date

None.

SharedOwnershipPercentage

byte

None.

SharedOwnershipRent

decimal number

None.

SharedOwnershipFrequency

byte

None.

ElectricMeterType

byte

None.

ElectricDisabled

byte

None.

GasMeterType

byte

None.

GasDisabled

byte

None.

WatermarkRequired

byte

None.

application/json, text/json

Sample:
{
  "leaseYears": 1,
  "id": 2,
  "description": "sample string 3",
  "fullDescription": "sample string 4",
  "bulletPoints": "sample string 5",
  "notes": "sample string 6",
  "contactID": 7,
  "userID": 8,
  "assistedByUserID": 9,
  "siteID": 10,
  "companyID": 11,
  "blockManagementCompanyID": 12,
  "altReference": "sample string 13",
  "status": 64,
  "statusDate": "2025-01-09T20:28",
  "category": 64,
  "tenure": 64,
  "type": 64,
  "sellingMethod": 64,
  "displayAddress": "sample string 20",
  "countryCode": 21,
  "propertyName": "sample string 22",
  "street": "sample string 23",
  "locality": "sample string 24",
  "town": "sample string 25",
  "region": "sample string 26",
  "postcode": "sample string 27",
  "country": "sample string 28",
  "propertyLocalAuthorityID": 29,
  "propertyTaxBandID": 30,
  "pricePrefix": 64,
  "price": 32.0,
  "priceMatch": 33.0,
  "priceFrequency": 64,
  "valuationPrice": 35.0,
  "potentialAnnualRent": 36.0,
  "deposit": 37.0,
  "currencyID": 38,
  "addedDate": "2025-01-09T20:28",
  "updatedDateTime": "2025-01-09T20:28",
  "marketDate": "2025-01-09T20:28",
  "expiryDate": "2025-01-09T20:28",
  "agencyType": 64,
  "introductionFee": 44.0,
  "introductionPercentage": 45.0,
  "commissionFee": 46.0,
  "commissionPercentage": 47.0,
  "paymentCycleID": 48,
  "detailsFileName": "sample string 49",
  "picturesHighRes": "sample string 50",
  "pictures": "sample string 51",
  "pictureWebMain": 64,
  "floorPlanFileNameWeb": "sample string 53",
  "floorPlanFileNamePrint": "sample string 54",
  "directions": "sample string 55",
  "built": 56,
  "newHome": 64,
  "exclusiveHome": 64,
  "age": 64,
  "bedrooms": 64,
  "permittedOccupiers": 64,
  "bathrooms": 64,
  "receptionRooms": 64,
  "gardens": 64,
  "land": 64,
  "lift": 64,
  "garage": 64,
  "parkingOffStreet": 68,
  "doubleGlazing": 64,
  "centralHeating": 64,
  "openFireStove": 64,
  "gas": 64,
  "electric": 64,
  "water": 64,
  "drainage": 64,
  "telephone": 64,
  "cable": 64,
  "otherServices": "sample string 78",
  "rentalAvailableDate": "2025-01-09T20:28",
  "rentalTerms": 64,
  "rentalMinimumTerm": 81,
  "rentalBenefit": 64,
  "rentalPets": 64,
  "rentalIncludesBills": 64,
  "rentalFurnished": 64,
  "rentalChildren": 64,
  "rentalStudents": 64,
  "rentalHMO": 64,
  "rentalSmokers": 64,
  "rentalManagementType": 64,
  "managementTypeID": 91,
  "viewingArrangements": 92,
  "viewingNotes": "sample string 93",
  "propertyAreaID": 94,
  "board": 95,
  "utilitySupplierGasID": 96,
  "utilitySupplierElectricityID": 97,
  "utilitySupplierWaterID": 98,
  "utilitySupplierTelephoneID": 99,
  "utilitySupplierCableID": 100,
  "utilitySupplierDrainageID": 101,
  "utilitySupplierGasRef": "sample string 102",
  "utilitySupplierElectricityRef": "sample string 103",
  "utilitySupplierWaterRef": "sample string 104",
  "utilitySupplierTelephoneRef": "sample string 105",
  "utilitySupplierCableRef": "sample string 106",
  "utilitySupplierDrainageRef": "sample string 107",
  "forceWebUpload": 64,
  "salesProgressorID": 109,
  "solicitorID": 110,
  "propertyDevelopmentID": 111,
  "virtualTourURL": "sample string 112",
  "virtualTourURL2": "sample string 113",
  "advertDescription": "sample string 114",
  "webFeatured": 64,
  "groundRent": 116.0,
  "groundRentFrequency": 64,
  "serviceCharge": 118.0,
  "serviceChargeFrequency": 64,
  "disabledAccess": 64,
  "retirement": 64,
  "developmentPotential": 64,
  "investmentPotential": 64,
  "requiresUpdating": 64,
  "riverside": 64,
  "seaside": 64,
  "firstTimeBuyersOnly": 64,
  "leisureFacilities": 64,
  "leaseExpiryDate": "2025-01-09T20:28",
  "floorArea": 130.0,
  "landArea": 131.0,
  "floor": 64,
  "soldPrice": 133.0,
  "mortgageAmount": 134.0,
  "depositAmount": 135.0,
  "managingAgentID": 136,
  "epcNotRequired": 64,
  "uploadPDF": 64,
  "disinstructionTypeID": 139,
  "longitude": 140.0,
  "latitude": 141.0,
  "mapZoomLevel": 64,
  "suppressStreetView": 64,
  "streetViewHeading": 144,
  "qualification": 64,
  "shortCode": 146,
  "propertyChainID": 147,
  "float": 148.0,
  "lonRes": 64,
  "commissionSplit": 150.0,
  "useClass": 64,
  "contactBankID": 152,
  "floorAreaMin": 153.0,
  "usage": 64,
  "floorAreaPrice": 155.0,
  "primaryProperty": 64,
  "linkedTo": 157,
  "lettingFees": "sample string 158",
  "detailsSent": 64,
  "occupierID": 160,
  "gasPrePayment": 64,
  "electricityPrePayment": 64,
  "electricityEconomy7": 64,
  "progressionManagedBy": 64,
  "viewingsManagedBy": 64,
  "clientLoginUpdated": 64,
  "webUploadSummary": 64,
  "applicantMatchingType": 64,
  "uploadPictures": 64,
  "localPropertyTaxNumber": "sample string 170",
  "uniqueReferenceNumber": "sample string 171",
  "what3Words": "sample string 172",
  "councilTaxRate": 173.0,
  "councilTaxRateExpiryDate": "2025-01-09T20:28",
  "sharedOwnershipPercentage": 64,
  "sharedOwnershipRent": 176.0,
  "sharedOwnershipFrequency": 64,
  "electricMeterType": 64,
  "electricDisabled": 64,
  "gasMeterType": 64,
  "gasDisabled": 64,
  "watermarkRequired": 64
}

application/xml, text/xml

Sample:
<Properties xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LeaseYears>1</LeaseYears>
  <ID>2</ID>
  <Description>sample string 3</Description>
  <FullDescription>sample string 4</FullDescription>
  <BulletPoints>sample string 5</BulletPoints>
  <Notes>sample string 6</Notes>
  <ContactID>7</ContactID>
  <UserID>8</UserID>
  <AssistedByUserID>9</AssistedByUserID>
  <SiteID>10</SiteID>
  <CompanyID>11</CompanyID>
  <BlockManagementCompanyID>12</BlockManagementCompanyID>
  <AltReference>sample string 13</AltReference>
  <Status>64</Status>
  <StatusDate>2025-01-09T20:28:48.7923801+00:00</StatusDate>
  <Category>64</Category>
  <Tenure>64</Tenure>
  <Type>64</Type>
  <SellingMethod>64</SellingMethod>
  <DisplayAddress>sample string 20</DisplayAddress>
  <CountryCode>21</CountryCode>
  <PropertyName>sample string 22</PropertyName>
  <Street>sample string 23</Street>
  <Locality>sample string 24</Locality>
  <Town>sample string 25</Town>
  <Region>sample string 26</Region>
  <Postcode>sample string 27</Postcode>
  <Country>sample string 28</Country>
  <PropertyLocalAuthorityID>29</PropertyLocalAuthorityID>
  <PropertyTaxBandID>30</PropertyTaxBandID>
  <PricePrefix>64</PricePrefix>
  <Price>32</Price>
  <PriceMatch>33</PriceMatch>
  <PriceFrequency>64</PriceFrequency>
  <ValuationPrice>35</ValuationPrice>
  <PotentialAnnualRent>36</PotentialAnnualRent>
  <Deposit>37</Deposit>
  <CurrencyID>38</CurrencyID>
  <AddedDate>2025-01-09T20:28:48.7923801+00:00</AddedDate>
  <UpdatedDateTime>2025-01-09T20:28:48.7923801+00:00</UpdatedDateTime>
  <MarketDate>2025-01-09T20:28:48.7923801+00:00</MarketDate>
  <ExpiryDate>2025-01-09T20:28:48.7923801+00:00</ExpiryDate>
  <AgencyType>64</AgencyType>
  <IntroductionFee>44</IntroductionFee>
  <IntroductionPercentage>45</IntroductionPercentage>
  <CommissionFee>46</CommissionFee>
  <CommissionPercentage>47</CommissionPercentage>
  <PaymentCycleID>48</PaymentCycleID>
  <DetailsFileName>sample string 49</DetailsFileName>
  <PicturesHighRes>sample string 50</PicturesHighRes>
  <Pictures>sample string 51</Pictures>
  <PictureWebMain>64</PictureWebMain>
  <FloorPlanFileNameWeb>sample string 53</FloorPlanFileNameWeb>
  <FloorPlanFileNamePrint>sample string 54</FloorPlanFileNamePrint>
  <Directions>sample string 55</Directions>
  <Built>56</Built>
  <NewHome>64</NewHome>
  <ExclusiveHome>64</ExclusiveHome>
  <Age>64</Age>
  <Bedrooms>64</Bedrooms>
  <PermittedOccupiers>64</PermittedOccupiers>
  <Bathrooms>64</Bathrooms>
  <ReceptionRooms>64</ReceptionRooms>
  <Gardens>64</Gardens>
  <Land>64</Land>
  <Lift>64</Lift>
  <Garage>64</Garage>
  <ParkingOffStreet>68</ParkingOffStreet>
  <DoubleGlazing>64</DoubleGlazing>
  <CentralHeating>64</CentralHeating>
  <OpenFireStove>64</OpenFireStove>
  <Gas>64</Gas>
  <Electric>64</Electric>
  <Water>64</Water>
  <Drainage>64</Drainage>
  <Telephone>64</Telephone>
  <Cable>64</Cable>
  <OtherServices>sample string 78</OtherServices>
  <RentalAvailableDate>2025-01-09T20:28:48.7923801+00:00</RentalAvailableDate>
  <RentalTerms>64</RentalTerms>
  <RentalMinimumTerm>81</RentalMinimumTerm>
  <RentalBenefit>64</RentalBenefit>
  <RentalPets>64</RentalPets>
  <RentalIncludesBills>64</RentalIncludesBills>
  <RentalFurnished>64</RentalFurnished>
  <RentalChildren>64</RentalChildren>
  <RentalStudents>64</RentalStudents>
  <RentalHMO>64</RentalHMO>
  <RentalSmokers>64</RentalSmokers>
  <RentalManagementType>64</RentalManagementType>
  <ManagementTypeID>91</ManagementTypeID>
  <ViewingArrangements>92</ViewingArrangements>
  <ViewingNotes>sample string 93</ViewingNotes>
  <PropertyAreaID>94</PropertyAreaID>
  <Board>95</Board>
  <UtilitySupplierGasID>96</UtilitySupplierGasID>
  <UtilitySupplierElectricityID>97</UtilitySupplierElectricityID>
  <UtilitySupplierWaterID>98</UtilitySupplierWaterID>
  <UtilitySupplierTelephoneID>99</UtilitySupplierTelephoneID>
  <UtilitySupplierCableID>100</UtilitySupplierCableID>
  <UtilitySupplierDrainageID>101</UtilitySupplierDrainageID>
  <UtilitySupplierGasRef>sample string 102</UtilitySupplierGasRef>
  <UtilitySupplierElectricityRef>sample string 103</UtilitySupplierElectricityRef>
  <UtilitySupplierWaterRef>sample string 104</UtilitySupplierWaterRef>
  <UtilitySupplierTelephoneRef>sample string 105</UtilitySupplierTelephoneRef>
  <UtilitySupplierCableRef>sample string 106</UtilitySupplierCableRef>
  <UtilitySupplierDrainageRef>sample string 107</UtilitySupplierDrainageRef>
  <ForceWebUpload>64</ForceWebUpload>
  <SalesProgressorID>109</SalesProgressorID>
  <SolicitorID>110</SolicitorID>
  <PropertyDevelopmentID>111</PropertyDevelopmentID>
  <VirtualTourURL>sample string 112</VirtualTourURL>
  <VirtualTourURL2>sample string 113</VirtualTourURL2>
  <AdvertDescription>sample string 114</AdvertDescription>
  <WebFeatured>64</WebFeatured>
  <GroundRent>116</GroundRent>
  <GroundRentFrequency>64</GroundRentFrequency>
  <ServiceCharge>118</ServiceCharge>
  <ServiceChargeFrequency>64</ServiceChargeFrequency>
  <DisabledAccess>64</DisabledAccess>
  <Retirement>64</Retirement>
  <DevelopmentPotential>64</DevelopmentPotential>
  <InvestmentPotential>64</InvestmentPotential>
  <RequiresUpdating>64</RequiresUpdating>
  <Riverside>64</Riverside>
  <Seaside>64</Seaside>
  <FirstTimeBuyersOnly>64</FirstTimeBuyersOnly>
  <LeisureFacilities>64</LeisureFacilities>
  <LeaseExpiryDate>2025-01-09T20:28:48.7923801+00:00</LeaseExpiryDate>
  <FloorArea>130</FloorArea>
  <LandArea>131</LandArea>
  <Floor>64</Floor>
  <SoldPrice>133</SoldPrice>
  <MortgageAmount>134</MortgageAmount>
  <DepositAmount>135</DepositAmount>
  <ManagingAgentID>136</ManagingAgentID>
  <EPCNotRequired>64</EPCNotRequired>
  <UploadPDF>64</UploadPDF>
  <DisinstructionTypeID>139</DisinstructionTypeID>
  <Longitude>140</Longitude>
  <Latitude>141</Latitude>
  <MapZoomLevel>64</MapZoomLevel>
  <SuppressStreetView>64</SuppressStreetView>
  <StreetViewHeading>144</StreetViewHeading>
  <Qualification>64</Qualification>
  <ShortCode>146</ShortCode>
  <PropertyChainID>147</PropertyChainID>
  <Float>148</Float>
  <LonRes>64</LonRes>
  <CommissionSplit>150</CommissionSplit>
  <UseClass>64</UseClass>
  <ContactBankID>152</ContactBankID>
  <FloorAreaMin>153</FloorAreaMin>
  <Usage>64</Usage>
  <FloorAreaPrice>155</FloorAreaPrice>
  <PrimaryProperty>64</PrimaryProperty>
  <LinkedTo>157</LinkedTo>
  <LettingFees>sample string 158</LettingFees>
  <DetailsSent>64</DetailsSent>
  <OccupierID>160</OccupierID>
  <GasPrePayment>64</GasPrePayment>
  <ElectricityPrePayment>64</ElectricityPrePayment>
  <ElectricityEconomy7>64</ElectricityEconomy7>
  <ProgressionManagedBy>64</ProgressionManagedBy>
  <ViewingsManagedBy>64</ViewingsManagedBy>
  <ClientLoginUpdated>64</ClientLoginUpdated>
  <WebUploadSummary>64</WebUploadSummary>
  <ApplicantMatchingType>64</ApplicantMatchingType>
  <UploadPictures>64</UploadPictures>
  <LocalPropertyTaxNumber>sample string 170</LocalPropertyTaxNumber>
  <UniqueReferenceNumber>sample string 171</UniqueReferenceNumber>
  <What3Words>sample string 172</What3Words>
  <CouncilTaxRate>173</CouncilTaxRate>
  <CouncilTaxRateExpiryDate>2025-01-09T20:28:48.7923801+00:00</CouncilTaxRateExpiryDate>
  <SharedOwnershipPercentage>64</SharedOwnershipPercentage>
  <SharedOwnershipRent>176</SharedOwnershipRent>
  <SharedOwnershipFrequency>64</SharedOwnershipFrequency>
  <ElectricMeterType>64</ElectricMeterType>
  <ElectricDisabled>64</ElectricDisabled>
  <GasMeterType>64</GasMeterType>
  <GasDisabled>64</GasDisabled>
  <WatermarkRequired>64</WatermarkRequired>
</Properties>