Portals
- Supported Roles
- Available Services
- Current User's Portal
- Portal Description
- Expansions
- API Explorer
Supported Roles
Role |
Reads |
Writes |
Notes |
IDX |
Yes |
No |
|
Public |
Yes |
No |
|
VOW |
Yes |
No |
|
Portal |
Yes |
No |
|
Private |
Yes |
Yes |
|
More information about roles
may be found here.
Available Services
Current User's Portal
/<API Version>/portal
HTTP Method |
Description |
Notes |
GET |
Returns the portal information for the current user |
|
POST |
Creates a portal |
|
PUT |
Updates an existing portal |
|
DELETE |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
No parameters
GET Response
Example:
{
"D": {
"Success": true,
"Results": [{
"ResourceUri": "/v1/portal/20100912153422758914000000",
"Id": "20100912153422758914000000",
"OwnerId": "20110000000000000000000001",
"ModificationTimestamp": 2011-11-18T16:35:43,
"Name": "greatportal",
"DisplayName": "GreatPortal",
"Enabled": true,
"RequiredFields": ["Address", "Phone"]
}]
}
}
POST Request
Request Body
{
"D": {
"DisplayName": "GreatPortal",
"Enabled": true,
"RequiredFields": ["Address", "Phone"]
}
}
POST Response
The
standard success/fail response is returned.
PUT Request
Any field used in the POST request to create a portal may be used in a PUT request to update the portal.
Request Body
{
"D": {
"Enabled": false
}
}
PUT Response
The
standard success/fail response is returned.
Portal Description
Data Type represents the type of the Value attribute
Attribute |
Data Type |
Description |
Id |
Character |
The unique id for the record. |
ResourceUri |
Character |
The resource URI to the portal record. |
Name |
Character |
The name of the portal, as used in the URI. |
DisplayName |
Character |
The name of the portal, as presented to end users. |
OwnerId |
Character |
The Id of the portal owner. |
AutoName |
Boolean |
If true, if DisplayName is not available or is not provided, a portal name will be automatically generated. |
Enabled |
Boolean |
If false, the portal is disabled and inaccessible by consumers. |
TaxInfo |
Boolean |
Show listing tax information in portal products |
History |
Boolean |
Show listing history in portal products |
Documents |
Boolean |
Show listing documents in portal products |
OpenHouses |
Boolean |
Show open houses in portal products |
AllowSignup |
Boolean |
Allow visitors to sign up for portal accounts |
SendLoginMessages |
Boolean |
Send portal owner a message when someone logs into a portal |
AutomaticFirstSearch |
Boolean |
Auto-create the first search for portal users |
Report |
Character |
Id of a report to show when viewing in flexmls web |
SendLeadsTo |
Character |
Id of an email address for the current user |
PortalSignupTemplate |
Character |
Id of an email template sent when manually creating a portal for someone |
PortalCreationTemplate |
Character |
Id of an email template sent when a user signs up for a portal |