Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Alpha Only: This service is subject to change

This service is a work in progress. It is currently subject to change or removal without notice.

Devices

The Devices service manages a user's devices native applications built on Spark API run on, allowing features such as push notifications.

 
  1. Supported Roles
  2. Available Services
    1. All Devices
    2. Individual Devices
  3. Devices Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW Yes Yes
Portal Yes Yes
Private Yes Yes

More information about roles may be found here.

 

Available Services

All Devices

/<API Version>/devices

HTTP Method Description Conditional Notes
GET Returns a list of devices registered for the current user No
POST Registers a device for the current user No
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": {
      "Results": [{
        "Id": "20100000000000000000000000",
        "ResourceUri": "/vX/devices/20100000000000000000000001",
        "OwnerId": "20100000000000000000000001",
        "DeviceToken": "a7d5f801637a582a89313de96edd7fe8",
        "Platform": "IOS",
        "Active": true,
        "ModificationTimestamp": "2012-01-11T09:50:18-05:00",
        "Notifications": {
           "NewsFeedEvents": ["New", "PriceChange"]
        }
      }]
    }
}
 

POST Request

Request body:

{
    "D": {
      "DeviceToken": "a7d5f801637a582a89313de96edd7fe8",
      "Platform": "IOS",
      "Active": true,
      "Notifications": {
         "NewsFeedEvents": ["Pending"]
      }
    }
}
 

POST Response

The standard success/fail response is returned.

 
 

Individual Devices

/<API Version>/devices/<Device.Id>

HTTP Method Description Conditional Notes
GET Returns a specific device No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates a device for the current user No
DELETE Removes a registered device No

GET Request

Parameters:

 

GET Response

See the GET request section for for the devices service.

PUT Request

Request body:

{
    "D": {
      "Notifications": {
         "NewsFeedEvents": ["PriceChange"]
      }
    }
}
 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Devices Description

Attribute Data Type Writeable Required Description
ResourceUri Character No No The URI to a particular device.
Id Character No No The unique id for the device.
Active Character Yes No If false, the device will not receive any push notifications for the current user.
Only one record per DeviceToken for all users (not just the current user) can be Active.
When set to true on create or update, all other records for the same DeviceToken will be updated to false.
When unspecified while creating a the first record for a DeviceToken, Active will default to true. Otherwise, the default is false.
DeviceToken Character Yes Yes The unique token registered for this device. Used when sending push notifications.
Platform Character Yes Yes The device's platform. Currently IOS and Android are supported.
ModificationTimestamp Timestamp No No The date and time when the device record was last modified.
Notifications JSON Object Yes No The types of resources and events the device will receive push notifications for.
NewsFeedEvents CharacterList Yes No The list of News Feed Events the device will receive push notifications for. If null, the device will be subscribed to all events. If [], the device is subscribed to no events. See our explanation of instant news feed notifications for more information.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.