Back | Webservices | Home

SelectPlaylist

Description

Returns a playlist object

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password

playlistID The Playlist ID
Type: int

Response Elements

Name Description

SelectPlaylistResult

A Playlist Object

Type: 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>
    <SelectPlaylist xmlns="http://vidzapper.net/Webservice/">
      <playlistID>int</playlistID>
    </SelectPlaylist>
  </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>
    <SelectPlaylistResponse xmlns="http://vidzapper.net/Webservice/">
      <SelectPlaylistResult>
        <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>
      </SelectPlaylistResult>
    </SelectPlaylistResponse>
  </soap12:Body>
</soap12:Envelope>