Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.
Flexmls: Listing Reports
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
| 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
All Flexmls Listing Reports
/<API Version>/flexmls/listingreports
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns a list of all listing reports in flexmls Web available 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:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"FlexmlsId": "s,fulllistA",
"Name": "Standard"
},
{
"FlexmlsId": "s,fulllistB",
"Name": "Standard Style B"
},
{
"FlexmlsId": "s,lp",
"Name": "Details at the side, with photo"
},
{
"FlexmlsId": "s,l",
"Name": "Details at the side, no photo"
},
{
"FlexmlsId": "s,lr",
"Name": "Details at the side, no photo, profile info"
},
{
"FlexmlsId": "s,lpr",
"Name": "Details at the side, with photo, profile info"
},
{
"FlexmlsId": "s,full",
"Name": "Full Report"
}
]
}
}
Listing Reports Description
| Attribute | Data Type | Description |
|---|---|---|
FlexmlsId |
Character | A unique identifier for the report. These IDs are non-standard to Spark, and are constructed in a way that allows legacy flexmls Web applications to decipher the type, and sub-type, of each report. |
Name |
Character | The human-presentable name of the report. |
Expansions
None.