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 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 Messages 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 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

Listing Videos

The Listing Videos sub-service retrieval of URIs to videos associated with a specified listing.

 
  1. Supported Roles
  2. Available Services
    1. Videos
    2. Individual Video
  3. Video Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes Special permission required

More information about roles may be found here.

 

Available Services

Videos

/<API Version>/listings/<Listing.Id>/videos
/<API Version>/listings/incomplete/<IncompleteListing.Id>/videos

HTTP Method Description Conditional Notes
GET Returns all videos associated with a specified listing No
POST Creates a video for a specified listing No GroupId is optional. Videos with the same GroupId represent a different Type of the same video. For example, this should be set to the GroupId of the existing unbranded video when saving the branded version.
PUT Allows the reordering of videos assocatied with a specified listing No For the global PUT to the listing, currently only the Id attribute is accepted and is currently intended to be used for reordering videos for a listing.
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/videos/20101213041526458274000000",
                "Id": "20101213041526458274000000",
                "GroupId": "20201022225107363901000000",
                "Name": "Video name",
                "Caption": "Caption text",
                "Type": "branded",
                "ObjectHtml": "<>"
            }
        ]
    }
}
 

POST Request

Request body:

{
    "D": {
         "GroupId": "20201022225107363901000000",
         "Name": "Video Name",
         "Caption": "Caption test",
         "Type": "branded",
         "ObjectHtml": "<>"
    }
}
 

POST Response

The standard success/fail response is returned.

 

PUT Request

Request body:

{
    "D": {
        "Videos": [
            {"Id": "20101213041526458274000000"},
            {"Id": "20101214041526458275000000"},
            {"Id": "20101215041526458276000000"},
            {"Id": "20101216041526458277000000"}
        ]
    }
}
 

PUT Response

The standard success/fail response is returned.

 
 

Video

/<API Version>/listings/<Listing.Id>/videos/<Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/videos/<Id>

HTTP Method Description Conditional Notes
GET Returns data for a specified video No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates the specified video information No
DELETE Deletes the specified video No

GET Request

Parameters:

 

GET Response

See the GET request section for for the Videos service.

PUT Request

Request body:

See the PUT request section for the Videos service.

 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Videos Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the video.
ResourceUri Character No No The URI to the particular video data (not the video itself).
GroupId Character Yes No The id to link a branded and an unbranded videos.
Name Character Yes Yes The name of the video.
Caption Character Yes No Text intended as the video's caption.
Type Character Yes No The type of the video, either branded or unbranded.
ObjectHtml Character Yes No The embeddable HTML to display the media.
Privacy Character Yes No Either Public or Private (default: Public). This is the desired privacy level of the video, and is used to determine the CurrentPrivacy attribute.
CurrentPrivacy Character No No Either Public or Private. Private videos will only be available to FBS products, and will only be available for private roles. Use this attribute to determine the active privacy level of the video.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.