GET api/listings?hqKey={hqKey}

Returns all the listings of headquarter

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hqKey

string

Required

Body Parameters

None.

Response Information

Resource Description

ListingsResponseViewModel
NameDescriptionTypeAdditional information
ListingDetails

ListingDetails

 Collection of ListingDetail

None.

Response Formats

application/json, text/json

Sample: 
{
  "ListingDetails": [
    {
      "ListingKey": "sample string 1",
      "ReviewCount": 2,
      "Status": "sample string 3",
      "BuildingName": "sample string 4",
      "Address": {
        "StreetNumber": "sample string 1",
        "StreetName": "sample string 2",
        "StreetType": "sample string 3",
        "City": "sample string 4",
        "State": "sample string 5",
        "ZipCode": "sample string 6",
        "CountryCode": "sample string 7"
      }
    },
    {
      "ListingKey": "sample string 1",
      "ReviewCount": 2,
      "Status": "sample string 3",
      "BuildingName": "sample string 4",
      "Address": {
        "StreetNumber": "sample string 1",
        "StreetName": "sample string 2",
        "StreetType": "sample string 3",
        "City": "sample string 4",
        "State": "sample string 5",
        "ZipCode": "sample string 6",
        "CountryCode": "sample string 7"
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<ListingsResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Listing">
  <ListingDetails>
    <ListingDetail>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apts.Api.Service.Models.Listing">
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:StreetName>sample string 2</d4p1:StreetName>
        <d4p1:StreetNumber>sample string 1</d4p1:StreetNumber>
        <d4p1:StreetType>sample string 3</d4p1:StreetType>
        <d4p1:ZipCode>sample string 6</d4p1:ZipCode>
      </Address>
      <BuildingName>sample string 4</BuildingName>
      <ListingKey>sample string 1</ListingKey>
      <ReviewCount>2</ReviewCount>
      <Status>sample string 3</Status>
    </ListingDetail>
    <ListingDetail>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apts.Api.Service.Models.Listing">
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:StreetName>sample string 2</d4p1:StreetName>
        <d4p1:StreetNumber>sample string 1</d4p1:StreetNumber>
        <d4p1:StreetType>sample string 3</d4p1:StreetType>
        <d4p1:ZipCode>sample string 6</d4p1:ZipCode>
      </Address>
      <BuildingName>sample string 4</BuildingName>
      <ListingKey>sample string 1</ListingKey>
      <ReviewCount>2</ReviewCount>
      <Status>sample string 3</Status>
    </ListingDetail>
  </ListingDetails>
</ListingsResponseViewModel>