Accounts: Associations
The Accounts Associations service lists the association data for a given user.
- Supported Roles
- Available Services
- Account Associations
- Association Description
- Expansions
- API Explorer
Supported Roles
Role |
Reads |
Writes |
Notes |
IDX |
No |
No |
|
Public |
No |
No |
|
VOW |
No |
No |
|
Portal |
No |
No |
|
Private |
Yes |
No |
|
More information about roles
may be found here.
Available Services
Account Associations
/<API Version>/accounts/<Account.Id>/associations
HTTP Method |
Description |
Conditional |
Notes |
GET |
|
No
|
The associations the current user belongs to |
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": {
"Success": true,
"Results": [
{
"Id": "20130117173750921178000000",
"MlsId": "20000426143505724628000000",
"Name": "People for the Ethical Treatment of Realtors",
"Primary": true,
"EmailRouting": {
"DestinationType": "destination@email.com"
}
}
]
}
}
Associations Description
Attribute |
Data Type |
Description |
MlsId |
Character |
The Id of the MLS the association belongs to. |
Name |
Character |
The display name of the association. |
Primary |
Boolean |
true if this is the primary association for the user. |
EmailRouting |
JSON Object |
Key value map describing where to route emails for this association. |
Expansions
None.
API Explorer
The API Explorer does not currently support this service.