Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.

Portals: Listing Categories

The portal homepage is allowed to have multiple Portal Listing Categories, and this resource supplies configuration and information on what listings to display for these categories as well as which ones to display and the desired order.

  1. Supported Roles
  2. Available Services
    1. Listing Categories
    2. Listing Category
  3. Listing Category Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Listing Categories

URI: /<API Version>/portal/listingcategories

HTTP Method Description Conditional Notes
GET Returns the portal listing categories. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

{
  "D": {
    "Success": true,
    "Results": [
      {
        "Category": "Active",
        "Label": "Active",
        "ResourceUri": "/v1/portal/listingcategories/Active",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'Active'",
        "Enabled": true
      },
      {
        "Category": "ActiveContingent",
        "Label": "Active Contingent",
        "ResourceUri": "/v1/portal/listingcategories/Active Contingent",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'UAC'",
        "Enabled": false
      },
      {
        "Category": "Pending",
        "Label": "Pending",
        "ResourceUri": "/v1/portal/listingcategories/Pending",
        "ListingUri": "/v1/my/listings",
        "Filter": "StandardStatus Eq 'Pending'",
        "Enabled": false
      },
      {
        "Category": "Sold30",
        "Label": "Recently Sold (within 30 days)",
        "ResourceUri": "/v1/portal/listingcategories/Recently Sold (within 30 days)",
        "ListingUri": "/v1/my/listings",
        "Filter": "CloseDate Gt days(-30)",
        "Enabled": false
      },
      {
        "Category": "OpenHouse7",
        "Label": "Upcoming Open Houses",
        "ResourceUri": "/v1/portal/listingcategories/Upcoming Open Houses",
        "ListingUri": "/v1/my/listings",
        "Filter": "OpenHouse Bt now(),days(7)",
        "Enabled": false
      }
    ]
  }
}

Listing Category

URI: /<API Version>/portal/listingcategories/<Category>

HTTP Method Description Conditional Notes
GET Returns a single portal listing category. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Enable a single portal listing category. Categories that support configuration may have the default Value modified here too. No
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

{
  "D": {
    "Success": true,
    "Results": [
      {
        "Category": "Active",
        "Label": "Active",
        "ResourceUri": "/v1/portal/listingcategories/Active",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'Active'",
        "Enabled": false
      }
    ]
  }
}

PUT Request

Request body:
{
  "D": {
    "Enabled": true
  }
}

PUT Response

The standard success/fail response is returned.

Listing Category Description

Attribute Data Type Writeable Required Description
Category Character The identifier for the portal listing category.
Label Character The name of the portal listing categorye.
ResourceUri Character The URI to the portal listing category.
ListingUri Character The listings service to use when requestings listings in this category.
Filter Character The search filter to apply for this category. Using this filter in conjunction with the ListingUri provides the listing results for this category.
Enabled Boolean Yes Enables the listing category on the portals home page.
Value Decimal Yes This attribute allows the user to customize a configurable category from a default setting. Only categories with a non null default are configurable. Applying a Value to a category that supports it will enable the category automatically.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.