Accounts: Metadata
The Accounts Metadata service describes the allowable values for searching and updating various account and profile fields, often varying by MLS.
Supported Roles
Role | Reads | Writes | Notes |
---|---|---|---|
IDX | Yes | No | |
Public | Yes | No | |
VOW | Yes | No | |
Portal | Yes | No | |
Private | Yes | No |
Available Services
Accounts Metadata
/<API Version>/accounts/meta
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | No | ||
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:- None
GET Response
{ "D": { "Success": true, "Results": { "Associations": [ { "Id": "20130117173750921178000000", "AssociationId" : "12345", "Name": "People for the Ethical Treatment of Realtors" } ], "Mls": [ { "Id": "20100127075503180752000000", "Name": "Realtors of the People"}. { "Id": "20070913202326493241000000", "Name": "Association of Ethical Realtors" }. ] "Tags": [ "Appraiser", "Realtor" ], "SearchableTags": [ "Realtor" ], "Emails": [ {"Name": "Home", "Value":"Home"}, {"Name": "Office", "Value":"Office"}, {"Name": "Other E-mail", "Value": "Other E-mail"}, {"Name": "MLS E-mail", "Value": "MLS E-mail"} ], "Phones": [ {"Name": "Home", "Value": "Home"}, {"Name": "Office", "Value": "Office"}, {"Name": "Fax", "Value": "Fax"}, {"Name": "Mobile", "Value": "Mobile"}, {"Name": "Pager", "Value": "Pager"}, {"Name": "Other Phone", "Value": "Other Phone"}, {"Name": "Voice", "Value": "Voice"}, {"Name": "Direct", "Value": "Direct"}, {"Name": "Toll-Free", "Value": "Toll-Free"}, {"Name": "2nd Home", "Value": "2nd Home"}, {"Name": "Primary", "Value": "Primary"}, {"Name": "2nd Fax", "Value": "2nd Fax"}, {"Name": "Modem", "Value": "Modem"}, {"Name": "Office Fax", "Value": "Office Fax"}, {"Name": "2nd Mobile", "Value": "2nd Mobile"}, {"Name": "2nd Pager", "Value": "2nd Pager"} ], "Websites": [ {"Name": "Home", "Value":"Home"}, {"Name": "Office", "Value":"Office"}, {"Name": "Other URL", "Value": "Other URL"}, {"Name": "Facebook", "Value":"Facebook"}, {"Name": "LinkedIn", "Value":"LinkedIn"}, {"Name": "Twitter", "Value":"Twitter"} ], "Images": [ {"Name": "Logo", "Value":"Logo"}, {"Name": "Photo", "Value":"Photo"}, {"Name": "Other Image", "Value": "Other Image"}, {"Name": "Forms Logo", "Value":"Forms Logo"} ], "Addresses": [ {"Name": "Home", "Value":"Home"}, {"Name": "Office", "Value":"Office"}, {"Name": "Other Address", "Value": "Other Address"}, {"Name": "Mailing Address", "Value":"Mailing Address"} ], "ProfilePermissions": { "Editable": true, "EditableSettings": { "Addresses": true, "Emails": true, "Documents": true, "Websites": true, "Phones": true, "Designation": true, "LanguagesSpoken": true, "MarketingName": true, "Name": true, "Password": true, "LicenseNumber": true, "Biography": true } } } } }
Accounts Metadata Description
Attribute | Data Type | Description |
---|---|---|
MlsId | Character | The Id of the MLS the meta data belongs to. |
SearchableTags | Character List | A list of tags whose users can be returned in account searches. |
Tags | Character List | A list of tags that can be associated with an account. |
Addresses | A list of Address types that can be added to a user's profile. | |
Mls | A list of MLSs that can be associated with an account. | |
Associations | A list of Associations that can be associated with a user's profile. | |
Emails | A list of E-mail types that can be added to a user's profile. | |
Images | A list of Image types that can be associated with a user's profile. | |
Phone | A list of Phone types that can be added to a user's profile. | |
Website | A list of Website types that can be added to a user's profile. | |
ProfilePermissions | Data detailing fields that are editable for a user's profile. These are settings defined by the MLS and vary per association. Priveleged Roles Only: Contains ExternalProfileLink and ExternalProfileLinkDescriptionattributes for MLSs that utilize additional, external profile management software. |
|
Designations | A list of designations that can be associated with a user's profile. The designations contain the FlexMLS desktop field ID, the name of the designation, and an enabled boolean to determine if this user can have this designation. |
Expansions
None.