Back | Webservices | Home

Pulse

Description

Sends a Pulse to the Statistics database.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password

guid Type: string
playlistID Type: Int64
playerID Type: Int64
contentID Type: Int64
contentMetaDataID Type: Int64
playheadTime Type: float
totalTime Type: float

Response Elements

Name Description

PulseResult

A StatsLog Object

Type: StatsLog

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>
    <Pulse xmlns="http://vidzapper.net/Webservice/">
      <guid>string</guid>
      <playlistID>long</playlistID>
      <playerID>long</playerID>
      <contentID>long</contentID>
      <contentMetaDataID>long</contentMetaDataID>
      <playheadTime>float</playheadTime>
      <totalTime>float</totalTime>
    </Pulse>
  </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>
    <PulseResponse xmlns="http://vidzapper.net/Webservice/">
      <PulseResult>
        <ID>long</ID>
        <GUID>string</GUID>
        <PlaylistID>long</PlaylistID>
        <PlayerID>long</PlayerID>
        <ContentID>long</ContentID>
        <ContentMetaDataID>long</ContentMetaDataID>
        <PlayheadTime>float</PlayheadTime>
        <TotalTime>float</TotalTime>
        <Timestamp>dateTime</Timestamp>
        <Error>
          <Status>string</Status>
          <Message>string</Message>
          <ResultCode>string</ResultCode>
        </Error>
      </PulseResult>
    </PulseResponse>
  </soap12:Body>
</soap12:Envelope>