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

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

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":  "http://www.flexmls.com/share/15Ar/3544-N-Olsen-Avenue-Filabee-AZ-85719",
                "ListingIds": ["20110224152431857619000000","20110125122333785431000000"],
                "Mode":"Idx"
            }
        ]
    }
}

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.
 

Expansions

None.

Expansions

None.