GET 17.0/app/properties/{id}/summary

Description

Gets basic information for a Contact and their Property Requirements

URI Parameters

Name Description Type Additional information
id

ID of the Contact to retrieve a summary for

integer

Required

None.

None.

A ContactSummaryResponse model

Name Description Type Additional information
ID

integer

None.

PictureCount

integer

None.

Address

string

None.

Category

IDDescriptionPair

None.

DisplayPrice

string

None.

Deposit

string

None.

Status

IDDescriptionPair

None.

Tenure

IDDescriptionPair

None.

AvailableDate

date

None.

Owner

Owner

None.

AcceptedOfferContact

IDDescriptionPair

None.

Type

IDDescriptionPair

None.

Bedrooms

byte

None.

ViewingArrangement

integer

None.

ViewingNotes

string

None.

Bathrooms

integer

None.

UploadStatus

string

None.

Furnished

IDDescriptionPair

None.

application/json, text/json

Sample:
{
  "id": 1,
  "pictureCount": 2,
  "address": "sample string 3",
  "category": {
    "id": 1,
    "description": "sample string 2"
  },
  "displayPrice": "sample string 4",
  "deposit": "sample string 5",
  "status": {
    "id": 1,
    "description": "sample string 2"
  },
  "tenure": {
    "id": 1,
    "description": "sample string 2"
  },
  "availableDate": "2025-01-09T20:08",
  "owner": {
    "id": 1,
    "name": "sample string 2",
    "emailAddress": "sample string 3",
    "mobileNumber": "sample string 4",
    "telephoneNumber": "sample string 5",
    "marketingPreferences": {
      "email": true,
      "telephone": true,
      "smsText": true,
      "confirmed": true
    }
  },
  "acceptedOfferContact": {
    "id": 1,
    "description": "sample string 2"
  },
  "type": {
    "id": 1,
    "description": "sample string 2"
  },
  "bedrooms": 64,
  "viewingArrangement": 7,
  "viewingNotes": "sample string 8",
  "bathrooms": 9,
  "uploadStatus": "sample string 10",
  "furnished": {
    "id": 1,
    "description": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<PropertySummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <PictureCount>2</PictureCount>
  <Address>sample string 3</Address>
  <Category>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </Category>
  <DisplayPrice>sample string 4</DisplayPrice>
  <Deposit>sample string 5</Deposit>
  <Status>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </Status>
  <Tenure>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </Tenure>
  <AvailableDate>2025-01-09T20:08:52.6104908+00:00</AvailableDate>
  <Owner>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <EmailAddress>sample string 3</EmailAddress>
    <MobileNumber>sample string 4</MobileNumber>
    <TelephoneNumber>sample string 5</TelephoneNumber>
    <MarketingPreferences>
      <Email>true</Email>
      <Telephone>true</Telephone>
      <SmsText>true</SmsText>
      <Confirmed>true</Confirmed>
    </MarketingPreferences>
  </Owner>
  <AcceptedOfferContact>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </AcceptedOfferContact>
  <Type>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </Type>
  <Bedrooms>64</Bedrooms>
  <ViewingArrangement>7</ViewingArrangement>
  <ViewingNotes>sample string 8</ViewingNotes>
  <Bathrooms>9</Bathrooms>
  <UploadStatus>sample string 10</UploadStatus>
  <Furnished>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </Furnished>
</PropertySummary>