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

URI: /<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:
  • None

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:
  • None

DELETE Response

The standard success/fail response is returned.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.