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: Listing Updates 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: 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: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters 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 Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields 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
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Portals

  1. Supported Roles
  2. Available Services
    1. Current User's Portal
  3. Portal 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

Current User's Portal

/<API Version>/portal

HTTP Method Description Notes
GET Returns the portal information for the current user
PUT Updates the portal information
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented
 

GET Request

No parameters

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [{
            "ResourceUri": "/v1/portal",
            "OwnerId": "20110000000000000000000001",
            "ModificationTimestamp": 2011-11-18T16:35:43,
            "Name": "greatportal",
            "DisplayName": "GreatPortal",
            "Enabled": true,
            "RequiredFields": ["Address", "Phone"],
            "TaxInfo": {"Value": true, "Editable": true},
            "History": {"Value": false, "Editable": true},
            "Documents": {"Value": true, "Editable": true},
            "OpenHouses": {"Value": true, "Editable": true},
            "AllowSignup": {"Value": true, "Editable": true},
            "SendLoginMessages": {"Value": true, "Editable": true},
            "AutomaticFirstSearch": {"Value": true, "Editable": true},
            "Report": {"Value": null, "Editable": true},
            "SendLeadsTo": {"Value": null, "Editable": true},
            "PortalSignupTemplate": {"Value": null, "Editable": true},
            "PortalCreationTemplate": {"Value": null, "Editable": true}
        }]
    }
}
 

POST Request

Request Body

{
    "D": {
      "DisplayName": "GreatPortal",
      "Enabled": true,
      "RequiredFields": ["Address", "Phone"]
    }
}
 

POST Response

The standard success/fail response is returned.

PUT Request

Any field used in the POST request to create a portal may be used in a PUT request to update the portal.

Request Body

{
    "D": {
      "Enabled": false,
      "TaxInfo": {"Value": true},
      "Report": { "Value": null }
    }
}
 

PUT Response

The standard success/fail response is returned.

 

Portal Description

Data Type represents the type of the Value attribute

Attribute Data Type Description
Id Character The unique id for the record.
ResourceUri Character The resource URI to the portal record.
Name Character The name of the portal, as used in the URI.
DisplayName Character The name of the portal, as presented to end users.
OwnerId Character The Id of the portal owner.
AutoName Boolean If true, if DisplayName is not available or is not provided, a portal name will be automatically generated.
Enabled Boolean If false, the portal is disabled and inaccessible by consumers.
TaxInfo Boolean Show listing tax information in portal products
History Boolean Show listing history in portal products
Documents Boolean Show listing documents in portal products
OpenHouses Boolean Show open houses in portal products
AllowSignup Boolean Allow visitors to sign up for portal accounts
SendLoginMessages Boolean Send portal owner a message when someone logs into a portal
AutomaticFirstSearch Boolean Auto-create the first search for portal users
Report Character Id of a report to show when viewing in flexmls web
SendLeadsTo Character Id of an email address for the current user
PortalSignupTemplate Character Id of an email template sent when manually creating a portal for someone
PortalCreationTemplate Character Id of an email template sent when a user signs up for a portal