System Info: Accounts
The Accounts sub-resource returns metadata describing valid components of an account record.
- Supported Roles
- Available Services
- Account Metadata
- Response Description
- Expansions
- API Explorer
Supported Roles
Role |
Reads |
Writes |
Notes |
IDX |
Yes |
No |
|
Public |
Yes |
No |
|
VOW |
Yes |
No |
|
Portal |
Yes |
No |
|
Private |
Yes |
No |
|
More information about roles
may be found here.
Available Services
Account Metadata
URI: /<API Version>/system/accounts
HTTP Method |
Description |
Notes |
GET |
Returns a list of accounts-related metadata. |
|
POST,PUT,DELETE |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
Parameters:
GET Response (Sample)
{
"D": {
"Success": true,
"Results": [
{
"Designations": [
{
"Code": "AB",
"Name": "Associate Broker",
"Editable": true
}
]
}
]
}
}
Response Description
Attribute |
Description |
Returned for Which User Type(s) |
Returned for Which API Key Role(s) |
Designations |
Contains a list of all designations that the MLS has defined. |
All |
All |
Designations.Code |
The "code" of the designation. The code is used when referring to a designation in other services and is independent of the name. |
All |
All |
Designations.Name |
The display name of the designation, which may differ from the code. |
All |
All |
Designations.Editable |
A boolean that, when set to true, indicates that the current user is allowed to set that designation on their own account. |
All |
All |
Expansions
None.
API Explorer
Interact with this service using the
API Explorer.