Back | Webservices | Home

GetTagCloud

Description

Returns the tagCloud. A list of TagCloud objects.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password
channelID The Channel ID
Type: int

Response Elements

Name Description

GetTagCloudResult

A List of tag Cloud Objects

Type: List TagCloud

Example using SOAP

Example Request

The following is a sample SOAP 1.2 request and response.

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <UserCredentials xmlns="http://vidzapper.net/Webservice/">
      <Userid>string</Userid>
      <Password>string</Password>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetTagCloud xmlns="http://vidzapper.net/Webservice/">
      <channelID>int</channelID>
    </GetTagCloud>
  </soap12:Body>
</soap12:Envelope>

Example Response

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTagCloudResponse xmlns="http://vidzapper.net/Webservice/">
      <GetTagCloudResult>
        <TagCloud>
          <ID>int</ID>
          <ChannelID>int</ChannelID>
          <PlaylistID>int</PlaylistID>
          <SearchWord>string</SearchWord>
          <SearchQuantity>int</SearchQuantity>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </TagCloud>
        <TagCloud>
          <ID>int</ID>
          <ChannelID>int</ChannelID>
          <PlaylistID>int</PlaylistID>
          <SearchWord>string</SearchWord>
          <SearchQuantity>int</SearchQuantity>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </TagCloud>
      </GetTagCloudResult>
    </GetTagCloudResponse>
  </soap12:Body>
</soap12:Envelope>