Contacts: Portal/VOW Accounts
The Portal account sub-service provides access to consumer account information.
These accounts are automatically created when a contact
is created or edited, but older contacts may not yet have a corresponding
consumer account.
- Supported Roles
- Available Services
- Portal Account
- Response Description
- Expansions
- API Explorer
Supported Roles
Role |
Reads |
Writes |
Notes |
IDX |
Yes |
Yes |
Writes allowed for portal creation only |
Public |
Yes |
No |
|
VOW |
Yes |
No |
|
Portal |
Yes |
No |
|
Private |
Yes |
Yes |
|
More information about roles
may be found here.
Available Services
Portal Account
/<API Version>/contacts/<Contact.Id>/portal
HTTP Method |
Description |
Notes |
GET |
Returns account information for the current user |
|
POST |
Creates a consumer account |
|
PUT |
Updates a consumer account |
|
DELETE |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
No parameters
GET Response
Example:
{
"D": {
"Success": true,
"Results: [{
"ResourceUri": "/vX/contacts/201010122342756895000000/portal",
"Id": "20060412165917817933000000",
"OwnerId": "20090410349683017933000000",
"LoginName": "dave",
"LastActive": "2012-03-07T21:13:11Z",
"Locale": {
"Language": "en"
},
"Identity": {
"Connected": true,
"Email": "dave_meyer@mailinator.com"
},
"Enabled": true
}]
}
}
POST Request
{
"D": {
"LoginName": "Johnny Everyman",
"Password": "MyPassw0rd",
"Settings": {
"Enabled": true
},
"Locale": {
"Language": "en"
}
}
}
POST Response
The
standard success/fail response is returned.
PUT Request
All fields used in the POST request may be used in a PUT request.
{
"D": {
"Password": "ANewPassw3rd",
"Settings": {
"Enabled": false
}
}
}
PUT Response
The
standard success/fail response is returned.
Response Description
Attribute |
Data Type |
Writeable |
Required |
Description |
LastActive |
Timestamp |
No |
No |
The last date and time the Portal user was active in the agent's portal. Note: this is only accurate to the hour,
as the timestamp is updated at most once per hour. |
LastLogin |
Timestamp |
No |
No |
(Deprecated in favor of LastActive).The last date and time the Portal user logged in to the agent's
portal. If null, the Portal user has never logged in to their account. |
LoginName |
Character |
Yes |
No |
If not provided, the contact's PrimaryEmail will be used as the login name. |
Password |
Character |
Yes |
No |
If not provided, a password will be created and sent back in the response. For security reasons, GET requests will not return
the password
|
Identity.Connected |
Boolean |
No |
No |
If true, the Portal account for your contact has been linked to a consumer's flexmls Web account.
Agents are linked to consumers by privileged applications using the Consumers: Agents service.
|
Identity.Email |
Boolean |
No |
No |
If connected, will populate the email used for the linked consumer account. |
Locale.Language |
Character |
Yes |
No |
The code for the user's preferred language. Consult the System Info: Languages service for supported languages, which may vary per MLS. |
Expansions
None.
API Explorer
The API Explorer does not currently support this service.