Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Overlays

The Overlays service returns Overlays, which are collections of Shapes, for use in searching and display.

 
  1. Supported Roles
  2. Available Services
    1. All Overlays
    2. Individual Overlays
  3. Overlays Description
  4. Expansions
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No

More information about roles may be found here.

 

Available Services

All Overlays

/<API Version>/overlays

HTTP Method Description Conditional Notes
GET Returns all overlays available to the user 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:

Parameter Required Notes
Standard search and paging syntax No
 
 

GET Response

{
    "D": {
        "Results": => [
            {
                "Id"=>"20200930182940798746000000",
                "ResourceUri"=>"/v1/overlays/20200930182940798746000000",
                "Name"=>"Big Shape",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2020-09-30T18:29:40Z",
                "ModificationTimestamp"=>"2020-11-19T19:52:59Z",
                "Public"=>false,
                "Inheritable"=>false
            },
            {
                "Id"=>"20131203155800244279000000",
                "ResourceUri"=>"/v1/overlays/20131203155800244279000000",
                "Name"=>"cityscapes",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2013-12-03T15:58:00Z",
                "ModificationTimestamp"=>"2013-12-03T15:58:00Z",
                "Public"=>false,
                "Inheritable"=>false
            }
        ],
        "Success": true
    }
}
 
 

Individual Overlay

/<API Version>/overlays/<Overlay.Id>

HTTP Method Description Conditional Notes
GET Returns a specified overlay record 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:

 

GET Response

{
    "D": {
        "Results": => [
            {
                "Id"=>"20200930182940798746000000",
                "ResourceUri"=>"/v1/overlays/20200930182940798746000000",
                "Name"=>"Big Shape",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2020-09-30T18:29:40Z",
                "ModificationTimestamp"=>"2020-11-19T19:52:59Z",
                "Public"=>false,
                "Inheritable"=>false
            }
        ],
        "Success": true
    }
}
 
 

Overlays Description

Attribute Data Type Description
Id Character The unique id for the Overlay.
ResourceUri Character The URI to the Overlay.
Name Character The Name of the Overlay.
OwnerId Character The Account.Id of the Overlay's owner
Inherited Boolean Whether the overlay is inherited, ie., is owned by another user but is available to the current user.
Inheritable Boolean Whether the overlay can be inherited by other users.
Public Boolean Whether the overlay is intended to be publicly available.
CreatedTimestamp DateTime The time the overlay record was created
ModificationTimestamp DateTime The time the overlay record was last modified
 

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Shapes All No No This expansion causes to be included all of the Shapes belonging to this overlay.