Back | Webservices | Home

GetOverview

Description

Returns an overview of the statistics.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password
clientID Client ID
Type: int
startDate Type: string
endDate Type: string

Response Elements

Name Description

GetOverviewResult

Stats Overview element.

Type: List of StatsOverview

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>
    <GetOverview xmlns="http://vidzapper.net/Webservice/">
      <clientID>int</clientID>
      <startDate>string</startDate>
      <endDate>string</endDate>
    </GetOverview>
  </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>
    <GetOverviewResponse xmlns="http://vidzapper.net/Webservice/">
      <GetOverviewResult>
        <StatsOverview>
          <Name>string</Name>
          <Data>string</Data>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
            <ResultCode>string</ResultCode>
          </Error>
        </StatsOverview>
        <StatsOverview>
          <Name>string</Name>
          <Data>string</Data>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
            <ResultCode>string</ResultCode>
          </Error>
        </StatsOverview>
      </GetOverviewResult>
    </GetOverviewResponse>
  </soap12:Body>
</soap12:Envelope>