GET api/estate/potentialmatches/{estateId}

Request Information

URI Parameters

Name	Description	Type	Additional information
estateId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ContactGroupSummary

Name	Type	Additional information
Id	integer	None.
Active	boolean	None.
Reference	string	None.
DisplayName	string	None.
Name	string	None.
FirstName	string	None.
Category	ContactCategoryType	None.
CategoryDescription	string	None.
Email	string	None.
Phone	string	None.
MobilePhone	string	None.
LanguageId	string	None.
Stealth	boolean	None.
Address	Address	None.
AccessDenied	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "active": true,
    "reference": "sample string 2",
    "displayName": "sample string 3",
    "name": "sample string 4",
    "firstName": "sample string 5",
    "category": "MARRIED_COUPLE",
    "categoryDescription": "sample string 6",
    "email": "sample string 7",
    "phone": "sample string 8",
    "mobilePhone": "sample string 9",
    "languageId": "sample string 10",
    "stealth": true,
    "address": {
      "longitude": "sample string 1",
      "latitude": "sample string 2",
      "id": 1,
      "street": "sample string 1",
      "houseNumber": 1,
      "houseNumberExtension": "sample string 2",
      "mailBox": "sample string 3",
      "city": "sample string 4",
      "zipCode": "sample string 5",
      "countryCode": "AD",
      "residence": "sample string 6"
    },
    "accessDenied": true
  },
  {
    "id": 1,
    "active": true,
    "reference": "sample string 2",
    "displayName": "sample string 3",
    "name": "sample string 4",
    "firstName": "sample string 5",
    "category": "MARRIED_COUPLE",
    "categoryDescription": "sample string 6",
    "email": "sample string 7",
    "phone": "sample string 8",
    "mobilePhone": "sample string 9",
    "languageId": "sample string 10",
    "stealth": true,
    "address": {
      "longitude": "sample string 1",
      "latitude": "sample string 2",
      "id": 1,
      "street": "sample string 1",
      "houseNumber": 1,
      "houseNumberExtension": "sample string 2",
      "mailBox": "sample string 3",
      "city": "sample string 4",
      "zipCode": "sample string 5",
      "countryCode": "AD",
      "residence": "sample string 6"
    },
    "accessDenied": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactGroupSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <ContactGroupSummary>
    <AccessDenied>true</AccessDenied>
    <Active>true</Active>
    <Address>
      <City>sample string 4</City>
      <CountryCode>AD</CountryCode>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>sample string 2</HouseNumberExtension>
      <Id>1</Id>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
      <MailBox>sample string 3</MailBox>
      <Residence>sample string 6</Residence>
      <Street>sample string 1</Street>
      <ZipCode>sample string 5</ZipCode>
    </Address>
    <Category>MARRIED_COUPLE</Category>
    <CategoryDescription>sample string 6</CategoryDescription>
    <DisplayName>sample string 3</DisplayName>
    <Email>sample string 7</Email>
    <FirstName>sample string 5</FirstName>
    <Id>1</Id>
    <LanguageId>sample string 10</LanguageId>
    <MobilePhone>sample string 9</MobilePhone>
    <Name>sample string 4</Name>
    <Phone>sample string 8</Phone>
    <Reference>sample string 2</Reference>
    <Stealth>true</Stealth>
  </ContactGroupSummary>
  <ContactGroupSummary>
    <AccessDenied>true</AccessDenied>
    <Active>true</Active>
    <Address>
      <City>sample string 4</City>
      <CountryCode>AD</CountryCode>
      <HouseNumber>1</HouseNumber>
      <HouseNumberExtension>sample string 2</HouseNumberExtension>
      <Id>1</Id>
      <Latitude>sample string 2</Latitude>
      <Longitude>sample string 1</Longitude>
      <MailBox>sample string 3</MailBox>
      <Residence>sample string 6</Residence>
      <Street>sample string 1</Street>
      <ZipCode>sample string 5</ZipCode>
    </Address>
    <Category>MARRIED_COUPLE</Category>
    <CategoryDescription>sample string 6</CategoryDescription>
    <DisplayName>sample string 3</DisplayName>
    <Email>sample string 7</Email>
    <FirstName>sample string 5</FirstName>
    <Id>1</Id>
    <LanguageId>sample string 10</LanguageId>
    <MobilePhone>sample string 9</MobilePhone>
    <Name>sample string 4</Name>
    <Phone>sample string 8</Phone>
    <Reference>sample string 2</Reference>
    <Stealth>true</Stealth>
  </ContactGroupSummary>
</ArrayOfContactGroupSummary>