Back | Webservices | Home

SelectPlaylists

Description

Returns a list of playlist 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

SelectPlaylistsResult

A List of Playlist Objects

Type: List Playlist

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>
    <SelectPlaylists xmlns="http://vidzapper.net/Webservice/">
      <channelID>int</channelID>
    </SelectPlaylists>
  </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>
    <SelectPlaylistsResponse xmlns="http://vidzapper.net/Webservice/">
      <SelectPlaylistsResult>
        <Playlist>
          <ID>int</ID>
          <Title>string</Title>
          <ShortDescription>string</ShortDescription>
          <LongDescription>string</LongDescription>
          <CreationDateTime>dateTime</CreationDateTime>
          <ModificationDateTime>dateTime</ModificationDateTime>
          <ExpiryDateTime>dateTime</ExpiryDateTime>
          <UserID>int</UserID>
          <ClientID>int</ClientID>
          <Scheduled>string</Scheduled>
          <TimeHH>int</TimeHH>
          <TimeMM>int</TimeMM>
          <TimeType>string</TimeType>
          <ParentID>int</ParentID>
          <Image>string</Image>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Playlist>
        <Playlist>
          <ID>int</ID>
          <Title>string</Title>
          <ShortDescription>string</ShortDescription>
          <LongDescription>string</LongDescription>
          <CreationDateTime>dateTime</CreationDateTime>
          <ModificationDateTime>dateTime</ModificationDateTime>
          <ExpiryDateTime>dateTime</ExpiryDateTime>
          <UserID>int</UserID>
          <ClientID>int</ClientID>
          <Scheduled>string</Scheduled>
          <TimeHH>int</TimeHH>
          <TimeMM>int</TimeMM>
          <TimeType>string</TimeType>
          <ParentID>int</ParentID>
          <Image>string</Image>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Playlist>
      </SelectPlaylistsResult>
    </SelectPlaylistsResponse>
  </soap12:Body>
</soap12:Envelope>