To use Web Services you need a VISUALPLANT account, at least 1 passkey and some content in your account for each service node represented below.
"GET" requests return a maximum of 10 titles per page, unless you specify a different value for max-results in your query. For pagination, specify start-index in your query (default start value is "0"). See an example query with results and pagination.
Replace italicized variables in each request below with your info.
XML output contains complete metadata and is typically used to populate pages with lists, thumbnails and to show credits, comments, ratings, tags, etc for a title. XSPF output is suited for playback of playlists in the Web player. You may change "XML" to "XSPF" on services below marked with "(XSPF available)".
Show Latest titles: (XSPF available)
Show titles in a category: (XSPF available)
Search titles: (XSPF available)
Search titles in a category: (XSPF available)
Search titles matching all credits: (XSPF available)
Search titles matching a single credit: (XSPF available)
Show top 100 most viewed titles: (XSPF available)
Show top 20 most e-mailed titles: (XSPF available)
Search titles owned by a user:
Show user titles:
Show user favorites:
Show if title/playlist is a user favorite: (is_favorite = 1 means title id is a favorite)
Show user friends:
Show a title: (XSPF available)
Show credits for a title:
Show comments for a title:
Show titles in a playlist: (XSPF available)
Generate Google Sitemap of your media library: (up to 50,000 returned in this request)
Use this PHP file to request the sitemap webservice and generate a gzipped file on your web server: sitemap.zip
Results and Pagination (max-results and start-index)
PUT requests, including inserts, updates and deletes. (Note: These services are case-sensitive. It needs to be "Insert" with a capital "I" and "Delete" with a capital "D" if written, or the cache will not overwrite with new data.)
Insert e-mail-a-friend (for e-mail-a-friend stats):
Insert user favorites (for titles and playlists):
Delete user favorites (for titles and playlists):
Insert a title impression (for viewership stats):
As with any Web site that displays dynamic content, we strongly urge the use of page-caching on your site to
ensure good performance and reliability for your users. Although the VISUALPLANT API is built to accomodate
many thousands of requests per second, we cannot control network-related issues. Page-caching will reduce the
chances of a failed connection between your application and VISUALPLANT and improve load times. If you would
like to use the
VISUALPLANT Venue™ micro-site builder templates for PHP or .NET which incorporate page-caching out-of-the-box,
read here.