Back | Webservices | Home

SelectContentByPlaylistID

Description

Returns a list of Content objects

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password
clientID The Client ID
Type: int
channelID The Channel ID
Type: int
playlistID The Playlist ID
Type: int
   

Response Elements

Name Description

SelectContentByPlaylistIDResult

A List of Content Objects

Type: List Content

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>
    <SelectContentByPlaylistID xmlns="http://vidzapper.net/Webservice/">
      <clientID>int</clientID>
      <channelID>int</channelID>
      <playlistID>int</playlistID>
    </SelectContentByPlaylistID>
  </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>
    <SelectContentByPlaylistIDResponse xmlns="http://vidzapper.net/Webservice/">
      <SelectContentByPlaylistIDResult>
        <Content>
          <ClientID>int</ClientID>
          <ChannelID>int</ChannelID>
          <PlaylistID>int</PlaylistID>
          <ContentSequenceID>int</ContentSequenceID>
          <ContentID>int</ContentID>
          <MetaDataID>int</MetaDataID>
          <Title>string</Title>
          <ShortDesc>string</ShortDesc>
          <LongDesc>string</LongDesc>
          <File>string</File>
          <URL>string</URL>
          <IsDefault>boolean</IsDefault>
          <IsFile>boolean</IsFile>
          <Image>string</Image>
          <Duration>float</Duration>
          <Height>float</Height>
          <Width>float</Width>
          <IsAvailable>boolean</IsAvailable>
          <Rating>string</Rating>
          <TranscriptText>string</TranscriptText>
          <TranscriptStartTime>string</TranscriptStartTime>
          <TranscriptEndTime>string</TranscriptEndTime>
          <TranscriptType>string</TranscriptType>
          <IsModerated>boolean</IsModerated>
          <IsRejected>boolean</IsRejected>
          <AdTag>string</AdTag>
          <Sequence>string</Sequence>
          <Keywords>string</Keywords>
          <UploadDateTime>dateTime</UploadDateTime>
          <ExpiryDateTime>dateTime</ExpiryDateTime>
          <VideoPath>string</VideoPath>
          <ThumnailPath>string</ThumnailPath>
          <ContentTypeID>int</ContentTypeID>
          <TypeTitle>string</TypeTitle>
          <TypeDescription>string</TypeDescription>
          <IsScheduled>boolean</IsScheduled>
          <Link>string</Link>
          <VideoLink>boolean</VideoLink>
          <TitleLink>boolean</TitleLink>
          <DoNotShowInPlaylist>boolean</DoNotShowInPlaylist>
          <NoClickAway>boolean</NoClickAway>
          <Categories>
            <Category xsi:nil="true" />
            <Category xsi:nil="true" />
          </Categories>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Content>
        <Content>
          <ClientID>int</ClientID>
          <ChannelID>int</ChannelID>
          <PlaylistID>int</PlaylistID>
          <ContentSequenceID>int</ContentSequenceID>
          <ContentID>int</ContentID>
          <MetaDataID>int</MetaDataID>
          <Title>string</Title>
          <ShortDesc>string</ShortDesc>
          <LongDesc>string</LongDesc>
          <File>string</File>
          <URL>string</URL>
          <IsDefault>boolean</IsDefault>
          <IsFile>boolean</IsFile>
          <Image>string</Image>
          <Duration>float</Duration>
          <Height>float</Height>
          <Width>float</Width>
          <IsAvailable>boolean</IsAvailable>
          <Rating>string</Rating>
          <TranscriptText>string</TranscriptText>
          <TranscriptStartTime>string</TranscriptStartTime>
          <TranscriptEndTime>string</TranscriptEndTime>
          <TranscriptType>string</TranscriptType>
          <IsModerated>boolean</IsModerated>
          <IsRejected>boolean</IsRejected>
          <AdTag>string</AdTag>
          <Sequence>string</Sequence>
          <Keywords>string</Keywords>
          <UploadDateTime>dateTime</UploadDateTime>
          <ExpiryDateTime>dateTime</ExpiryDateTime>
          <VideoPath>string</VideoPath>
          <ThumnailPath>string</ThumnailPath>
          <ContentTypeID>int</ContentTypeID>
          <TypeTitle>string</TypeTitle>
          <TypeDescription>string</TypeDescription>
          <IsScheduled>boolean</IsScheduled>
          <Link>string</Link>
          <VideoLink>boolean</VideoLink>
          <TitleLink>boolean</TitleLink>
          <DoNotShowInPlaylist>boolean</DoNotShowInPlaylist>
          <NoClickAway>boolean</NoClickAway>
          <Categories>
            <Category xsi:nil="true" />
            <Category xsi:nil="true" />
          </Categories>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Content>
      </SelectContentByPlaylistIDResult>
    </SelectContentByPlaylistIDResponse>
  </soap12:Body>
</soap12:Envelope>