Back | Webservices | Home

SelectPlayers

Description

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

SelectPlayersResult

A List of Player Objects

Type: List Player

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>
    <SelectPlayers xmlns="http://vidzapper.net/Webservice/">
      <channelID>int</channelID>
    </SelectPlayers>
  </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>
    <SelectPlayersResponse xmlns="http://vidzapper.net/Webservice/">
      <SelectPlayersResult>
        <Player>
          <ID>int</ID>
          <Title>string</Title>
          <ChannelID>int</ChannelID>
          <PlayerWidth>int</PlayerWidth>
          <PlayerHeight>int</PlayerHeight>
          <VideoControlWidth>int</VideoControlWidth>
          <VideoControlHeight>int</VideoControlHeight>
          <IsDefaultForAll>boolean</IsDefaultForAll>
          <FileLocation>string</FileLocation>
          <IsDefault>boolean</IsDefault>
          <GoogleAnalytics>string</GoogleAnalytics>
          <IsEmbedOn>boolean</IsEmbedOn>
          <PlayerPath>string</PlayerPath>
          <PlayerType>string</PlayerType>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Player>
        <Player>
          <ID>int</ID>
          <Title>string</Title>
          <ChannelID>int</ChannelID>
          <PlayerWidth>int</PlayerWidth>
          <PlayerHeight>int</PlayerHeight>
          <VideoControlWidth>int</VideoControlWidth>
          <VideoControlHeight>int</VideoControlHeight>
          <IsDefaultForAll>boolean</IsDefaultForAll>
          <FileLocation>string</FileLocation>
          <IsDefault>boolean</IsDefault>
          <GoogleAnalytics>string</GoogleAnalytics>
          <IsEmbedOn>boolean</IsEmbedOn>
          <PlayerPath>string</PlayerPath>
          <PlayerType>string</PlayerType>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Player>
      </SelectPlayersResult>
    </SelectPlayersResponse>
  </soap12:Body>
</soap12:Envelope>