Flexmls: Email Links
Like all flexmls subservices, the data provided from this service is not fully supported by
Spark API. This resource is meant to help application developers transition from legacy flexmls Web
features to Spark API.
- Supported Roles
- Available Services
- All Email Links
- Individual Email Links
- Email Links 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 |
The All Email Links service is only available for consumers or as a subresource of /contacts. |
More information about roles
may be found here.
Available Services
All Email Links
/<API Version>/flexmls/emaillinks
/<API Version>/contacts/<Contact.Id>/flexmls/emaillinks
HTTP Method |
Description |
Conditional |
Notes |
GET |
Returns email links delivered to the current user. |
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:
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": "20100815220615294367000000",
"ResourceUri": "/v1/flexmls/emaillinks/20100815220615294367000000",
"Type": "Listings",
"Subject": "Listings in Fargo",
"Description": null,
"Filter": "City Eq 'Fargo'",
"ReportUri": null,
"RestrictedUIComponents": ["Tax", "Documents", "OpenHouses"],
"ModificationTimestamp": "2013-06-27T10:01:06-05:00"
}
]
}
}
Individual Email Link
/<API Version>/contacts/<Contact.Id>/flexmls/emaillinks/<EmailLink.Id>
/<API Version>/flexmls/emaillinks/<EmailLink.Id>
HTTP Method |
Description |
Conditional |
Notes |
GET |
Returns information for a specific email link. |
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:
GET Response
See the GET request section for for the all email links service.
Listings in an Email Link
/<API Version>/flexmls/emaillinks/<EmailLink.Id>/listings
/<API Version>/flexmls/emaillinks/<EmailLink.Id>/listings/<Id>
HTTP Method |
Description |
Conditional |
Notes |
GET |
Provides the data for listings in an email link. Permissions will be based on the email link. |
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:
GET Response
See the GET request section for for the pagination block.
Email Links Description
Attribute |
Data Type |
Description |
ResourceUri |
Character |
The URI to the email link resource. |
Id |
Character |
The unique ID of the email link. |
Type |
Character |
The type of data delivered in the email link. Can be Listings or CMA. |
Subject |
Character |
The subject text for the email. |
Description |
Character |
Additional information about the email link. |
Filter |
Character |
The search filter representing the listing data emailed. Note that listings can also be retrieved for this link using the EmailLink _filter parameter as well. Only populated if Type: "Listings". |
ReportUri |
Character |
The link to the report referenced by the link. Only populated if Type: "CMA". |
RestrictedUIComponents |
Character |
List of UI components that should not be shown. See IDX Links documentation for more information. |
ModificationTimestamp |
Timestamp |
The time the email link was last updated. |
Expansions
None.
API Explorer
Interact with this service using the
API Explorer.