System Info

This documentation has moved to the Spark Platform website. Please click here to view.

The System Info API allows retrieval of some information relating to the configuration of the flexmls API, the current MLS, and the current user.

Applicable API Key Roles

This service is available to API keys with IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. More information about roles may be found here.

Authentication

Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Available Services

Get system info

URI: /<API Version>/system

HTTP Method Description Notes
GET See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response (Sample)

The response may vary based on the API key’s and the user’s permissions. Please see the description section below the sample response for more information.

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Name": "Sample User",
                "Id": "20000426173054342350000000",
                "Office": "Sample Office Inc",
                "OfficeId": "20000627173054072660000000",
                "Mls": "Your Local MLS",
                "MlsId": "20000426143505724628000000",
                "Configuration": [
                    {
                        "IdxDisclaimer": "The data relating to ...",
                        "IdxLogo": "http://photos.flexmls.com/demomls/20050419215844627321000000.jpg",
                        "IdxLogoSmall": "http://photos.flexmls.com/demomls/20050419233651169360000000.jpg",
                        "MlsLogos": [
                            {
                                "Name:": "ABC MLS Logo",
                                "Uri": "http://photos.flexmls.com/demomls/20050419233651169360000000.jpg"
                            }
                        ],
                        "OAuth2ServiceEndpointPortal": "https://portal.flexmls.com/r/oauth2/sampleagent",
                        "CurrencyType": "USD",
                        "ExtendedActiveStatuses": {
                           "Enabled": true
                        }
                        "ExtendedPendingStatuses": {
                           "Enabled": false
                        }
                    }
                ]
            }
        ]
    }
}

Response Attribute Descriptions

Attribute Description Returned for Which User Type(s) Returned for Which API Key Role(s)
Name Name of the current user All All
Id ID of the current user All All
Office Name of the office that the user is in. Members. This attribute is omitted for other user types. All
OfficeId ID of the office. Members. This attribute is omitted for other user types. All
Mls Name of the local MLS All All
MlsId ID of the current MLS All All
Configuration.IdxDisclaimer Text of the disclaimer that must appear on IDX sites for the current MLS All All
Configuration.IdxLogo The IDX logo of the MLS, to be displayed with each IDX listing from that MLS All All
Configuration.IdxLogoSmall A smaller version of the IDX logo. If not present, IdxLogo should be used. All, though it will be omitted if there is no small logo defined by the MLS. All
Configuration.MlsLogos An array of objects with names and URIs of the MLS’s logos. All All
OAuth2ServiceEndpointPortal This is the URI of where the portal (consumer) user’s browser should be redirected to start the OAuth process. All IDX API key roles only
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 All
ExtendedActiveStatuses Shows whether the MLS has enabled extended active statuses, which is a way of creating statuses within the Active status. All All
ExtendedPendingStatuses Shows whether the MLS has enabled extended pending statuses, which is a way of creating statuses within the Pending status. All All

Accounts Metadata

URI: /<API Version>/system/accounts

HTTP Method Description Notes
GET Returns a list of accounts-related metadata, currently just member designations. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response (Sample)

Below is a sample response where the MLS has one designation available. This info applies across all accounts, not for just one account.

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Designations": [
                    {
                        "Code": "AB",
                        "Name": "Associate Broker",
                        "Editable": true
                    }
                ]
            }
        ]
    }
}

Response Attribute Descriptions

Attribute Description Returned for Which User Type(s) Returned for Which API Key Role(s)
Designations Contains a list of all designations that the MLS has defined. All All
Designations.Code The “code” of the designation. The code is used when referring to a designation in other services and is independent of the name. All All
Designations.Name The display name of the designation, which may differ from the code. All All
Designations.Editable A boolean that, when set to true, indicates that the current user is allowed to set that designation on their own account. All All

Language Metadata

URI: /<API Version>/system/languages

HTTP Method Description Notes
GET Returns a list of languages that a user may specify to be returned on their account. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response (Sample)

Below is a sample response where the MLS has three languages available. This info applies across all accounts, not for just one account.

{
    "D": {
        "Success": true,
        "Results": [
            {"Name": "English"},
            {"Name": "Spanish"},
            {"Name": "Chinese, Mandarin"}
        ]
    }
}

Comments on this entry are closed.