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: Mapping Layers Flexmls: Mapping Shapegen 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: Floor Plans 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: Floor Plans Listings: FloPlans Listings: Historical Listings: History 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 News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences 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
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Listings: Tickets

The Listing Tickets service returns a token that allows limited and temporary access to a listing on behalf of a user. Specific applications which support tickets will consume a ticket to provide an unauthenticated service request.

These Listing Tickets are currently used to give access for file uploads - photos and documents.

  1. Supported Roles
  2. Available Services
    1. Listing Tickets
  3. Response Description
  4. Expansions
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

Listing Tickets

/<API Version>/listings/<Listing.Id>/tickets

/<API Version>/listings/<Listing.Id>/photos/tickets

/<API Version>/listings/<Listing.Id>/documents/tickets

HTTP Method Description Notes
POST Creates a new service ticket
GET,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

POST Request

Parameters:

 

Request body:

{
    "D": {
        "Service": "PhotoUploads"
    }
}
 

POST Response

Example:

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Token": "ae788854e77d2f6c87d79c47b90c54ea",
                "ExpiresIn": 3600,
                "Service": "PhotoUploads"
                "Uri": "https:\/\/sparkplatform.com\/uploads\/photos"
            }
        ]
    }
}
 

Response Description

Attribute Data Type Writeable Description
Uri Character No The URI to the application that will accept this ticket.
Token Character No The unique identifier for this ticket. The client application is responsible for keeping this value secret prior to use.
ExpiresIn Integer No Time remaining to use this ticket before it expires (in seconds). The ticket will expire automatically after first successful use regardless of this value.
 

Expansions

None.