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

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.

Portal Groups: Current

VOW/Portal accounts can belong to multiple Portal Groups, and this resource allows VOW/Portal users to change which group they are currently acting on behalf of.

 
  1. Supported Roles
  2. Available Services
    1. Current Portal Group
  3. Portal Groups: Current Description
  4. Expansions
  5. API Explorer
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

Current Circle

/<API Version>/portal/groups/current

HTTP Method Description Conditional Notes
GET Returns the active portal group, if the current user belongs to a portal group and one has been selected. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Changes the current portal group for the current user. No
DELETE Detaches the active user from the current portal group. The relation will still exist, but subsequent operations will be on the user's own carts, searches and news feeds. If the user owns a circle, this circle will be automatically selected. No

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
             "Id": "20120212214851732931000000",
             "ResourceUri": "/v1/portal/groups/20120212214851732931000000",
             "ContactId": "20120112234853732441000000",
             "Users": [
                  {
                    "Id": "20110112234857732941000000",
                    "ResourceUri": "/v1/contacts/20110112234857732941000000",
                    "UserType": "Contact",
                    "Name": "Carl Contact",
                    "OfficeId": null,
                    "Office": null,
                    "CompanyId": null,
                    "Company": null
                  }
             ]
          }
       ]
    }
}
 

PUT Request

Request body:

{
    "D": {
      "Id" : "20110112234857732941000000"
    }
}
 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.