API Objects Reference

From ThirdPresence Wiki


Contents

VideoItem

Property name Type Read only Description
id long yes Content item's id set by ThirdPresence
providerid String no Content item's id set by the content item provider
name String no Name of the video
synopsis String no Longer description of the video
thumbnail String no URL to thumbnail image
position int no Position inside the category (not necessarily used)
duration int yes Video duration as seconds
created String yes Content item creation date
releasetime String no Content item release date, i.e. when the item is made available for usage
expiretime String no Content item expiration date. i.e. when the item is made unavailable. 0 means that item never expires
adurl String no URL to ad server for requesting ads tied to content item
status String no Status of the item (active, processed, deleted...)
description String no Description of the content item
embedtag String yes Embed tag information for this item
landingurl String yes Landing page URL for the content item
directurl String yes Direct URL for accessing the item. Use this HTTP URL in your code to provide access to the content item
downloadurl String yes URL to provide forced http delivery.
sourceurl String no URL of original video file. This should be used when using insertVideo method.
categoryid String no Id of the category that contains this item
categoryproviderid String no Id of the provider set by ThirdPresence
geolocationArray String[] no Geolocation access data related to this item
metadata Map<String, String> no Provider specific metadata items (e.g. rating, comments) related to this item

ContentcategoryItem

Property name Type Read only Description
categoryId int yes Category id used to identify a category
referenceId String no Static reference point to a single category
name String no Name of the category
iconlocation String no URL to the category icon
sourceurl String no Source URL to category's content. Can point to e.g. service provider's CMS system producing an RSS feed or then to ThirdPresence's internal FTP system
type int no Type of the category. Can be 'vodvideo' (for a category storing a number of video clips) or 'livevideo' (for live video feeds)

ErrorItem

Property name Type Read only Description
code int yes Error code
message String yes Description of the error
errorresponse (String) yes Response definition string

List of Error codes.


This page was last modified on 1 December 2010, at 09:14.