Shared Listings

The Shared Listings service creates permalinks to listings. The permalink is intended to be viewed by a web browser.
  1. Supported Roles
  2. Available Services
    1. Shared Listings
    2. Individual Shared Listing
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX Yes Yes
Public Yes Yes
VOW Yes Yes
Portal Yes Yes
Private Yes Yes
More information about roles may be found here.

Available Services

All Shared Listings

/<API Version>/sharedlistings

HTTP Method Description
GET, PUT, DELETE Returns HTTP 405 (Method Not Allowed). Not implemented.
POST Creates a new shared listings URI.

POST Request

    "D": {
        "ListingIds": ["20110224152431857619000000","20110125122333785431000000"]

POST Response

Identical to the GET response.

Individual Shared Listings

/<API Version>/sharedlistings/<Id>

HTTP Method Description
GET Returns information about a particular shared listing.
POST,PUT, DELETE Returns HTTP 405 (Method Not Allowed). Not implemented.

GET Response

    "D": {
        "Success": true,
        "Results": [
                "Id": "15Ar",
                "ResourceUri":  "/v1/sharedlistings/15Ar",
                "SharedUri":  "",
                "ListingIds": ["20110224152431857619000000","20110125122333785431000000"],

Account Description

Attribute Data Type Writeable Required Description
ResourceId Character No No The resource URI to the shared link.
Id Character No No The unique id for the shared link.
SharedUri Character No No The URI to the shared listing results in flexmls Web.
ListingIds Character List Yes Yes An array of listing IDs as returned by the Listings service. At least one value is required.
Mode Character Private Roles No Vow, Public or Idx. Indicates the mode in which the current listing(s) were shared. Vow role keys are set to a Public mode.





API Explorer

Interact with this service using the API Explorer.