GET api/listings/hq?listingKey={listingKey}

Returns every listing belonging to the same HQ as the supplied listing.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
listingKey

Listing key of a known property belonging to the client.

 string

None.

Body Parameters

None.

Response Information

Resource Description

HqListingsResponseViewModel
NameDescriptionTypeAdditional information
TotalCount

Gets or sets the number of listings under the HQ. Always the length of Listings.

 integer

None.
Listings

Gets or sets every listing under the HQ, including the one whose key was submitted.

 Collection of HqListingViewModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalCount": 1,
  "Listings": [
    {
      "ListingKey": "sample string 1",
      "PropertyName": "sample string 2",
      "Address": {
        "StreetAddress": "sample string 1",
        "City": "sample string 2",
        "StateCode": "sample string 3",
        "PostalCode": "sample string 4",
        "CountryCode": "sample string 5"
      }
    },
    {
      "ListingKey": "sample string 1",
      "PropertyName": "sample string 2",
      "Address": {
        "StreetAddress": "sample string 1",
        "City": "sample string 2",
        "StateCode": "sample string 3",
        "PostalCode": "sample string 4",
        "CountryCode": "sample string 5"
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<HqListingsResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Listing">
  <Listings>
    <HqListingViewModel>
      <Address>
        <City>sample string 2</City>
        <CountryCode>sample string 5</CountryCode>
        <PostalCode>sample string 4</PostalCode>
        <StateCode>sample string 3</StateCode>
        <StreetAddress>sample string 1</StreetAddress>
      </Address>
      <ListingKey>sample string 1</ListingKey>
      <PropertyName>sample string 2</PropertyName>
    </HqListingViewModel>
    <HqListingViewModel>
      <Address>
        <City>sample string 2</City>
        <CountryCode>sample string 5</CountryCode>
        <PostalCode>sample string 4</PostalCode>
        <StateCode>sample string 3</StateCode>
        <StreetAddress>sample string 1</StreetAddress>
      </Address>
      <ListingKey>sample string 1</ListingKey>
      <PropertyName>sample string 2</PropertyName>
    </HqListingViewModel>
  </Listings>
  <TotalCount>1</TotalCount>
</HqListingsResponseViewModel>