POST api/estatesearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
QueryString	string	None.
MinPrice	decimal number	None.
MaxPrice	decimal number	None.
ForSale	boolean	None.
ForRent	boolean	None.
PortfolioSearchType	PortfolioSearchType	None.
Active	boolean	None.
EstateCategory	EstateCategoryType	None.
EstateSort	EstateSortType	None.
MinimumNumberOfBedrooms	integer	None.
ResponsibleLoginId	integer	None.
SalesRepresentative	integer	None.
Page	Page	None.

Request Formats

application/json, text/json

Sample:

{
  "queryString": "sample string 1",
  "minPrice": 1.0,
  "maxPrice": 1.0,
  "forSale": true,
  "forRent": true,
  "portfolioSearchType": "PROSPECT",
  "active": true,
  "estateCategory": "Residential",
  "estateSort": "Dwelling",
  "minimumNumberOfBedrooms": 1,
  "responsibleLoginId": 1,
  "salesRepresentative": 1,
  "page": {
    "pageNumber": 1,
    "size": 2,
    "totalElements": 3,
    "totalPages": 4,
    "capped": true
  }
}

application/xml, text/xml

Sample:

<EstateQuickSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Page>
    <Capped>true</Capped>
    <PageNumber>1</PageNumber>
    <Size>2</Size>
    <TotalElements>3</TotalElements>
    <TotalPages>4</TotalPages>
  </Page>
  <Active>true</Active>
  <EstateCategory>Residential</EstateCategory>
  <EstateSort>Dwelling</EstateSort>
  <ForRent>true</ForRent>
  <ForSale>true</ForSale>
  <MaxPrice>1</MaxPrice>
  <MinPrice>1</MinPrice>
  <MinimumNumberOfBedrooms>1</MinimumNumberOfBedrooms>
  <PortfolioSearchType>PROSPECT</PortfolioSearchType>
  <QueryString>sample string 1</QueryString>
  <ResponsibleLoginId>1</ResponsibleLoginId>
  <SalesRepresentative>1</SalesRepresentative>
</EstateQuickSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EstateQuickSearchResult

Name	Type	Additional information
Estates	Collection of FuseEstateSummary	None.
Page	Page	None.
Success	boolean	None.
Status	Errata	None.
Errors	Collection of string	None.
Message	string	None.
StackTrace	string	None.
Exception	Exception	None.

Response Formats

application/json, text/json

Sample:

{
  "estates": [
    {
      "accessDenied": true,
      "id": 1,
      "active": true,
      "reference": "sample string 3",
      "price": 1.0,
      "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"
      },
      "category": "Residential",
      "categoryDescription": "sample string 4",
      "sort": "Dwelling",
      "sortDescription": "sample string 5",
      "genre": "ArchitectDwelling",
      "genreDescription": "sample string 6",
      "transactionType": "SALE",
      "transactionTypeDescription": "sample string 7",
      "transactionStatus": "FOR_SALE",
      "transactionStatusDescription": "sample string 8",
      "transactionFlowStatus": "PROSPECT_FOR_RENT",
      "transactionFlowStatusDescription": "sample string 9",
      "responsibleLoginId": 1,
      "salesRepresentative": 1
    },
    {
      "accessDenied": true,
      "id": 1,
      "active": true,
      "reference": "sample string 3",
      "price": 1.0,
      "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"
      },
      "category": "Residential",
      "categoryDescription": "sample string 4",
      "sort": "Dwelling",
      "sortDescription": "sample string 5",
      "genre": "ArchitectDwelling",
      "genreDescription": "sample string 6",
      "transactionType": "SALE",
      "transactionTypeDescription": "sample string 7",
      "transactionStatus": "FOR_SALE",
      "transactionStatusDescription": "sample string 8",
      "transactionFlowStatus": "PROSPECT_FOR_RENT",
      "transactionFlowStatusDescription": "sample string 9",
      "responsibleLoginId": 1,
      "salesRepresentative": 1
    }
  ],
  "page": {
    "pageNumber": 1,
    "size": 2,
    "totalElements": 3,
    "totalPages": 4,
    "capped": true
  },
  "success": true,
  "status": "OK",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "message": "sample string 2",
  "stackTrace": "sample string 3",
  "exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:

<Result.EstateQuickSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <StackTrace>sample string 3</StackTrace>
  <Status>OK</Status>
  <Success>true</Success>
  <Page>
    <Capped>true</Capped>
    <PageNumber>1</PageNumber>
    <Size>2</Size>
    <TotalElements>3</TotalElements>
    <TotalPages>4</TotalPages>
  </Page>
  <Estates>
    <FuseEstateSummary>
      <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>Residential</Category>
      <CategoryDescription>sample string 4</CategoryDescription>
      <Genre>ArchitectDwelling</Genre>
      <GenreDescription>sample string 6</GenreDescription>
      <Id>1</Id>
      <Price>1</Price>
      <Reference>sample string 3</Reference>
      <ResponsibleLoginId>1</ResponsibleLoginId>
      <SalesRepresentative>1</SalesRepresentative>
      <Sort>Dwelling</Sort>
      <SortDescription>sample string 5</SortDescription>
      <TransactionFlowStatus>PROSPECT_FOR_RENT</TransactionFlowStatus>
      <TransactionFlowStatusDescription>sample string 9</TransactionFlowStatusDescription>
      <TransactionStatus>FOR_SALE</TransactionStatus>
      <TransactionStatusDescription>sample string 8</TransactionStatusDescription>
      <TransactionType>SALE</TransactionType>
      <TransactionTypeDescription>sample string 7</TransactionTypeDescription>
      <AccessDenied>true</AccessDenied>
    </FuseEstateSummary>
    <FuseEstateSummary>
      <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>Residential</Category>
      <CategoryDescription>sample string 4</CategoryDescription>
      <Genre>ArchitectDwelling</Genre>
      <GenreDescription>sample string 6</GenreDescription>
      <Id>1</Id>
      <Price>1</Price>
      <Reference>sample string 3</Reference>
      <ResponsibleLoginId>1</ResponsibleLoginId>
      <SalesRepresentative>1</SalesRepresentative>
      <Sort>Dwelling</Sort>
      <SortDescription>sample string 5</SortDescription>
      <TransactionFlowStatus>PROSPECT_FOR_RENT</TransactionFlowStatus>
      <TransactionFlowStatusDescription>sample string 9</TransactionFlowStatusDescription>
      <TransactionStatus>FOR_SALE</TransactionStatus>
      <TransactionStatusDescription>sample string 8</TransactionStatusDescription>
      <TransactionType>SALE</TransactionType>
      <TransactionTypeDescription>sample string 7</TransactionTypeDescription>
      <AccessDenied>true</AccessDenied>
    </FuseEstateSummary>
  </Estates>
</Result.EstateQuickSearchResult>