Here is a current description of the webservice methods
available for developing players and applications on the VidZapper
platform.
|
Method Name
|
Section
Name
|
Description
|
|
|
|
|
|
AddTag
|
TagCloud
|
Adds a new Tag to the Tag Cloud manually.
|
|
Authenticate
|
General
|
Used to check you are authenticated. You will need to include
the soap:header in all calls to the webservice.
|
|
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.
|
|
CountryList
|
Country
|
Returns a list of countries.
|
|
CreateTagCloud
|
TagCloud
|
Automatically run through all the videos in a given playlist and
generate the tags and the quanitity fields.
|
|
FlushCache
|
General
|
Used to flush the system's cache, This is usually only used on
the development environment while you test your code.
|
|
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.
|
|
GetCategory
|
Category
|
Returns a category limited by the category ID.
|
|
GetCountry
|
Country
|
Returns a country.
|
|
GetLanguage
|
Language
|
Returns the name and description of a selected language.
|
|
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.
|
|
GetUserRole
|
Users
|
Returns a UserRole object limited by the ID.
|
|
LanguageList
|
Language
|
Returns a list of language objects
|
|
LoginUser
|
Users
|
Authenticates a user and returns a User object.
|
|
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.
|
|
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
|
|
SelectChannel
|
Channel
|
Returns a channel object, information about a particular channel
|
|
SelectChannels
|
Channel
|
Returns a list of channel objects
|
|
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
|
|
SelectPlayer
|
Player
|
Returns a player object
|
|
SelectPlayers
|
Player
|
Returns a list of player objects
|
|
SelectPlaylist
|
Playlist
|
Returns a playlist object
|
|
SelectPlaylists
|
Playlist
|
Returns a list of playlist objects
|
|
SelectStatisticsByChannelID
|
Statistics
|
Returns viewing statistics by channel
|
|
SelectStatisticsByID
|
Statistics
|
Returns total viewing statistics by content item
|
|
SelectStatisticsByMetaDataID
|
Statistics
|
Returns total viewing statistics by video
|
|
SelectStatisticsByPlaylistID
|
Statistics
|
Returns total viewing statistics by playlist
|
|
SelectStatisticsCountByChannelID
|
Statistics
|
Returns average viewing statistics by channel
|
|
SelectStatisticsCountByMetaDataID
|
Statistics
|
Returns average viewing statistics by video
|
|
SelectStatisticsCountByPlaylistID
|
Statistics
|
Returns average viewing statistics by playlist
|
|
SelectStatisticsCountDateRangeByChannelID
|
Statistics
|
Returns average viewing statistics by channel within a date
range
|
|
SelectStatisticsCountDateRangeByMetaDataID
|
Statistics
|
Returns average viewing statistics by video within a date range
|
|
SelectStatisticsCountDateRangeByPlaylistID
|
Statistics
|
Returns average viewing statistics by playlist within a date
range
|
|
SelectStatisticsDateRangeByChannelID
|
Statistics
|
Returns viewing statistics by channel within a date range
|
|
SelectStatisticsDateRangeByMetaDataID
|
Statistics
|
Returns viewing statistics by video within a date range
|
|
SelectStatisticsDateRangeByPlaylistID
|
Statistics
|
Returns viewing statistics by playlist within a date range
|
|
SendPasswordReminder
|
Users
|
Returns password reminder
|
|
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.
|
|
TestConnection
|
General
|
Tests the connection and authentication with the webservice.
|
|
UserRoleList
|
Users
|
Returns the full list of User Roles available
|
|
GetVelocixStats
|
Statistics
|
returns a list of VelocixStats objects filtered by the Client
ID, Reseller ID and a date range
|
|
GetVelocixStatsTop10
|
Statistics
|
returns a list of VelocixStatsTop10 objects filtered by the
Client ID, Reseller ID and a date range
|
|
GetVelocixStatsChart
|
Statistics
|
returns a list of VelocixStatsChart objects filtered by the
Client ID, Reseller ID ,Type and a date range
|
|
GetVelocixStatsExport
|
Statistics
|
returns a list of VelocixStatsExport objects filtered by the
Client ID, Reseller ID,Type and a date range
|
|
GetVelocixToken
|
Statistics
|
returns a VelocixToken objects
|
|
LogStatistics
|
Statistics
|
Log the Statistics
|
|
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)
|
|
Share
|
Users
|
This method used by Registered user to share currently playing
content(Tell a Friend)
|
|
GetCategoryTreeByChannelID
|
Category
|
This method returns categories filter by Channel ID
|
|
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
|
|
Registration
|
Users
|
This method used for Registeration of New User
|