Back | Webservices | Home

StartHeartBeat

Description

Stats the Heartbeat function for the Statistics database.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password

clientID Type: Int64
channelID Type: Int64
requestedIP Type: string
screenResolution Type: string
appVersion Type: string
appName Type: string
guid Type: string

Response Elements

Name Description

StartHeartBeatResult

A Stats Object

Type: Stats

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>
    <StartHeartBeat xmlns="http://vidzapper.net/Webservice/">
      <clientID>long</clientID>
      <channelID>long</channelID>
      <requestedIP>string</requestedIP>
      <screenResolution>string</screenResolution>
      <appVersion>string</appVersion>
      <appName>string</appName>
      <guid>string</guid>
    </StartHeartBeat>
  </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>
    <StartHeartBeatResponse xmlns="http://vidzapper.net/Webservice/">
      <StartHeartBeatResult>
        <ID>long</ID>
        <ClientID>long</ClientID>
        <ChannelID>long</ChannelID>
        <RequestedIP>string</RequestedIP>
        <ScreenResolution>string</ScreenResolution>
        <AppVersion>string</AppVersion>
        <AppName>string</AppName>
        <GUID>string</GUID>
        <Timestamp>dateTime</Timestamp>
        <Error>
          <Status>string</Status>
          <Message>string</Message>
          <ResultCode>string</ResultCode>
        </Error>
      </StartHeartBeatResult>
    </StartHeartBeatResponse>
  </soap12:Body>
</soap12:Envelope>