System Info

Listing Display Rules
Each MLS defines rules each application must abide by when displaying listing reports or brief summary data (such as listing search results). Review the Compliance page for details.
The System Info API provides information relating to the configuration of the Spark API, the current MLS, and the current user.
  1. Supported Roles
  2. Available Services
    1. System Information
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes
IDX Yes No
VOW Yes No
Private Yes Yes
More information about roles may be found here.

Available Services

System Information

URI: /<API Version>/system

HTTP Method Description Notes
GET Returns system information
PUT Update supported configuration settings.
POST,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response (Sample)

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Name": "Sample User",
                "Id": "20000426173054342350000000",
                "Office": "Sample Office Inc",
                "OfficeId": "20000627173054072660000000",
                "Company": "Sample Company Inc",
                "CompanyId": "20000627173054072670000000",
                "Mls": "Your Local MLS",
                "MlsId": "20000426143505724628000000",
                "Configuration": [
                    {   
                        "PasswordReset": true,
                        "PasswordAlternativeUri": null,
                        "TimeZone":"Central Time (US & Canada)",
                        "TimeZoneOffset":"-0500",
                        "TimeZoneAbbreviation": "CDT",
                        "IdxDisclaimer": "The data relating to ...",
                        "IdxDisclaimerTextOnly": "The data relating to ...",
                        "IdxLogo": "http://photos.sparkplatform.com/demomls/20050419215844627321000000.jpg",
                        "IdxLogoSmall": "http://photos.sparkplatform.com/demomls/20050419233651169360000000.jpg",
                        "MapDefaultExtent": {
                          "StartLongitude": -125.645160,
                          "StartLatitude": 21.525020,
                          "EndLongitude":  -65.984662,
                          "EndLatitude": 50.783808,
                          "SystemDefault": true
                        },
                        "MlsLogos": [
                            {
                                "Name:": "ABC MLS Logo",
                                "Uri": "http://photos.sparkplatform.com/demomls/20050419233651169360000000.jpg"
                            }
                        ],
                        "OAuth2ServiceEndpointPortal": "https://portal.flexmls.com/r/oauth2/sampleagent",
                        "CurrencyType": "USD",
                        "ExtendedActiveStatuses": {
                           "Enabled": true
                        }
                        "ExtendedPendingStatuses": {
                           "Enabled": false
                        }
                    }  
                ],
                "DisplayCompliance":{
                   "20000426143505724628000000":{
                      "View":{
                         "Detail":{
                            "DisplayCompliance":[
                               "ListOfficeName",
                               "ListOfficePhone",
                               "ListOfficeEmail"
                            ]
                         },
                         "Summary":{
                            "DisplayCompliance":[
                               "ListOfficeName"               
                            ]
                         }
                      },
                      "DisclaimerText":"Information is deemed to be reliable, but is not guaranteed.",
                      "DisclaimerTextOnly":"Information is deemed to be reliable, but is not guaranteed."
                   }
                }
            }
        ]
    }
}

PUT Request

Request body:
{
    "D": {
      "Configuration": [{
        "QuietTime": {
          "Days": ["Saturday", "Sunday"],
          "Times": [{
            "StartTime": "8:00 am",
            "EndTime": "6:00 pm"
          }]
        }
      }]
    }
}

PUT Response

The standard success/fail response is returned.

Response Description

Attribute Description Returned for Which API Key Role(s)
Name Name of the current user. All
Id ID of the current user. All
Office Name of the office that the user is in. All
OfficeId ID of the office. All
Company Name of the company that the user is in. All
CompanyId ID of the company. All
Mls Name of the current MLS. All
MlsId ID of the current MLS. All
Configuration.IdxDisclaimer Text of the disclaimer that must appear on IDX sites for the current MLS. See also DisplayCompliance.DisclaimerText. All
Configuration.IdxDisclaimerTextOnly Disclaimer text stripped of all html tags that can appear on IDX applications which don't support html for the current MLS in place of the IDXDisclaimer attribute. See also DisplayCompliance.DisclaimerTextOnly. All
Configuration.IdxLogo The IDX logo of the MLS, to be displayed with each IDX listing from that MLS. All
Configuration.IdxLogoSmall A smaller version of the IDX logo. If not present, IdxLogo should be used. All
Configuration.MapDefaultExtent The latitude and longitude values defined by the user, MLS, or system, that define the default map boundaries. If SystemDefault is true, no MLS default was found, and the values represent a system-determined default. All
Configuration.MlsLogos An array of objects with names and URIs of the MLS's logos. All
Configuration.PasswordReset true if the current user belongs to an MLS that allows password resets through the API. All
Configuration.PasswordAlternativeUri If Configuration.PasswordReset is false this may be set to an alternative URI the user can be sent to in order to reset the password for their account. All
Configuration.MlsLogos An array of objects with names and URIs of the MLS's logos. All
Configuration.QuietTime A mapping of the days and times that the current user has blocked off for quiet time. During these periods, email notifications and other event updates will not be sent to this user. If a day is listed (e.g. ["Saturday","Sunday"]), the entire day will be quiet. Otherwise, the time ranges (e.g. [{"StartTime": "6:00 pm", "EndTime": "8:00 am"}]) are enforced for the current day.
Time zones are locked to the MLS.
Private
DisplayCompliance A mapping of MLS IDs to corresponding display compliance rules. All
OAuth2ServiceEndpointPortal This is the URI of where the VOW (consumer) user's browser should be redirected to start the OAuth process. IDX, VOW
CurrencyType This returns a code that corresponds to a currency symbol type. Some response values are, but are not limited to, USD for US Dollars, EUR for Euros, and PHP for Philippine pesos. All
ExtendedActiveStatuses true if each possible value for MlsStatusInformation should be considered a sub-status of Active. All
ExtendedPendingStatuses true if each possible value for MlsStatusInformation should be considered a sub-status of Pending. All

Expansions

None.

API Explorer

Interact with this service using the API Explorer.