Back | Webservices | Home

Methods By Webservices

Description

Below are all the methods, seperated by which webservice they belong to.

Category

Method Name Section Name Description
CategoriesByContentID Category Returns a list of categories limited by that category being associated with the content ID provided.
CategoriesByParentID Category Returns a list of categories limited by the parent categories ID which is provided.
GetCategory Category Returns a category limited by the category ID.
GetCategoryTreeByChannelID Category This method returns categories filter by Channel ID

Channel

Method Name Section Name Description
SelectChannel Channel Returns a channel object, information about a particular channel
SelectChannels Channel Returns a list of channel objects

Content

Method Name Section Name Description
SearchContent Content This method searches for content that contains the given keyword a.k.a (Words To Search).
SearchContentByCategory Content This method searches videos within a category which contains the given keyword.
SearchContentByCategoryAndMetaDataSequence Content This method searches videos within a category which contains the given keyword, and pick a particular meta data sequence ID
SearchContentByEverything Content This method searches for content that contains with all the metadata the given keyword.
SearchContentByEverythingAndMetaDataSequence Content This method searches for content that contains with all the metadata the given keyword. Using the Meta Data Sequence
SearchContentByKeywords Content This method searches for content that contains the given keyword. Limited to the keywords of the metadata
SearchContentByKeywordsAndMetaDataSequence Content This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaData Content This method searches for content that contains with all the metadata the given keyword. Except the categories.
SearchContentByMetaDataAndMetaDataSequence Content This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaDataSequence Content This method searches for content that contains the given keyword. Returning the Meta Data Sequence
SelectContentByChannelID Content Returns a list of content objects
SelectContentByChannelIDAndMetaDataSequence Content Returns a list of content objects Using the Meta Data Sequence
SelectContentByContentID Content Returns a content object
SelectContentByContentIDAndMetaDataSequence Content Returns a content object. Using the Meta Data Sequence
SelectContentByMetaDataID Content Returns a content object
SelectContentByMetaDataIDAndMetaDataSequence Content Returns a content object with meta data filtered by the metadata sequence ID
SelectContentByPlaylistID Content Returns a list of Content objects
SelectContentByPlaylistIDAndMetaDataSequence Content Returns a list of Content objects filtered by the playlist ID and the metaData Sequence ID
UGCContentRejected Content Reject the content and returns content object Containing message(Error/Successfully Rejected)
UGCContentAccepted Content Accept the content and returns content object Containing message(Error/Successfully Accepted)
UGCUploadContent Content Upload new content by Registered user and returns content object Containing message(Error/Successfully uploaded)

ContentType

Method Name Section Name Description
ContentTypeList Content Type This method returns the List of Content Type
ContentType Content Type This method returns the Content Type fileter By Content Type ID

Country

Method Name Section Name Description
CountryList Country Returns a list of countries.

Ecommerce

Method Name Section Name Description
GetEcommerce Ecommerce Returns an ecommerce object.
GetEcommerceByContentMetaDataID Ecommerce Returns a list of ecommerce objects.
CreateEcommerce Ecommerce Creates an ecommerce object.
RemoveEcommerce Ecommerce Removes an ecommerce object.
UpdateEcommerce Ecommerce Update an ecommerce object.

Feeds

Method Name Section Name Description
GenerateMRSSFeed Feeds Returns an XML MRSS feed of your content
GenerateMRSSFeedByDateRange Feeds Returns an XML MRSS feed of your content, limited by a date range
GenerateMRSSFeedByDateRangeAndMultiPlaylist Feeds Returns an XML MRSS feed of your content, limited by a date range, allowing multiple playlists
GenerateMRSSFeedByMultiPlaylist Feeds Returns an XML MRSS feed of your content
GenerateRSSFeed Feeds Generates an XML RSS feed of your content.
GenerateRSSFeedByDateRangeAndPlaylistsAndDeepLinking Feeds Generates an XML RSS feed of your content limited by date range, allowing multiple playlists, and built to allow deeplinking.

General

Method Name Section Name Description
Authenticate General Used to check you are authenticated. You will need to include the soap:header in all calls to the webservice.
FlushCache General Used to flush the system's cache, This is usually only used on the development environment while you test your code.
GetClientsByResellerID General Used to get the clients details that belong to the reseller account.
SelectChannels General Returns a list of channel objects
SelectPlaylists General Returns a list of playlist objects

Heartbeat

Description
Method Name Section Name Description
Pulse Stats Sends a pulse to statistics.
StartHeartBeat Stats Starts the process of the heartbeat for statistics.

Player

Method Name Section Name Description
SelectPlayer Player Returns a player object
SelectPlayers Player Returns a list of player objects

Playlist

Method Name Section Name Description
SelectPlaylist Playlist Returns a playlist object
SelectPlaylists Playlist Returns a list of playlist objects

StatsAdmin

Method Name Section Name Description
GetClientAverageNoVidoesViewed StatsAdmin Returns the average number of videos viewed.
GetClientAverageNoVidoesViewedPerSession StatsAdmin Returns the average number of videos viewed per viewer session.
GetClientAverageSessionsPerViewer StatsAdmin Returns the average number of sessions per viewer
GetClientAverageSessionTime StatsAdmin Returns the average session viewing time
GetClientAverageViewingTime StatsAdmin Returns the average viewing time
GetChartViewers StatsAdmin Returns chart viewers over time
GetClientTotalData StatsAdmin Returns Total data transfered
GetClientTotalDataByDate StatsAdmin Returns the Total data transfered by date
GetClientTotalVideosViewed StatsAdmin Returns the number of total videos viewed
GetClientTotalSessions StatsAdmin Returns the Total number of viewer sessions
GetClientTotalSessionTime StatsAdmin Returns the total session time
GetClientTotalStorage StatsAdmin Returns the total storage
GetClientTotalVideos StatsAdmin Returns the Total number of videos
GetClientTotalViewers StatsAdmin Returns the Total number of viewers
GetOverview StatsAdmin Returns an overview of the statistics.
GetTop10Videos StatsAdmin Returns the Top 10 popular videos.
GetTotalStorage StatsAdmin Get total storage space from CDN

Search

Method Name Section Name Description
SearchContent Search This method searches for content that contains the given keyword a.k.a (Words To Search).
SearchContentByCategory Search This method searches videos within a category which contains the given keyword.
SearchContentByCategoryAndMetaDataSequence Search This method searches videos within a category which contains the given keyword, and pick a particular meta data sequence ID
SearchContentByEverything Search This method searches for content that contains with all the metadata the given keyword.
SearchContentByEverythingAndMetaDataSequence Search This method searches for content that contains with all the metadata the given keyword. Using the Meta Data Sequence
SearchContentByKeywords Search This method searches for content that contains the given keyword. Limited to the keywords of the metadata
SearchContentByKeywordsAndMetaDataSequence Search This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaData Search This method searches for content that contains with all the metadata the given keyword. Except the categories.
SearchContentByMetaDataAndMetaDataSequence Search This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaDataSequence Search This method searches for content that contains the given keyword. Returning the Meta Data Sequence

Stats Admin Advanced

Method Name Section Name Description
GetClipPlays StatsAdminAdvanced Returns the number of times a clip has been played
GetViewerSessionLengthByGUID StatsAdminAdvanced Returns the session length by GUID
GetViewerTotalLength StatsAdminAdvanced Returns the time a viewer has been watching.

TagCloud

Method Name Section Name Description
AddTag TagCloud Adds a new Tag to the Tag Cloud manually.
CreateTagCloud TagCloud Automatically run through all the videos in a given playlist and generate the tags and the quanitity fields.
GetTagCloud TagCloud Returns the tagCloud. A list of TagCloud objects.
GetTagCloudByPlaylistID TagCloud Returns the tagCloud. Ffiltered by a playlist ID.
GetTagCloudByPlaylistIDs TagCloud Returns the tagCloud. Filtered by a list of playlist IDs.
RemoveTag TagCloud Removes a specified Tag from the Tag Cloud.
RemoveTagByChannelID TagCloud Removes all Tags from the Tag Cloud. For a specified Channel
RemoveTagByID TagCloud Removes a specific Tag from the Tag Cloud.
TagClicked TagCloud Increments the value of the Search Quantity, filtered by the channelID and the TagID.
TagClickedByWord TagCloud Increments the value of the Search Quantity, filtered by the channelID and the Search Word.

Users

Method Name Section Name Description
GetUserRole Users Returns a UserRole object limited by the ID.
SendPasswordReminder Users This Method sends the user a reminder of their password.
UserRoleList Users Returns the full list of User Roles available
Share Users This method used by Registered user to share currently playing content(Tell a Friend)
Registration Users This method used for Registeration of New User

VzSync

Method Name Section Name Description
CreateVzSync VzSync Creates a new VzSync Object.
GetVzSyncByContentMetaDataID VzSync Returns the VzSync object By Content Meta Data ID
GetVzSyncByGuid VzSync Returns the VzSync object By GUID.
UpdateVzSync VzSync Updates a VzSync Object
RemoveVzSync VzSync Removes a VzSync Object