H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

Reports_Execute

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Reports_Execute"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Reports_Execute xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <ReportID>int</ReportID>
        <ClearCache>boolean</ClearCache>
        <Format>CSV or XML</Format>
        <Compression>NONE or GZIP or ZIP</Compression>
        <Filters>
          <Filter>
            <ID>int</ID>
            <Column>string</Column>
            <Value>string</Value>
            <Type>string</Type>
            <Operand>string</Operand>
            <Operator>string</Operator>
            <Editable>boolean</Editable>
          </Filter>
          <Filter>
            <ID>int</ID>
            <Column>string</Column>
            <Value>string</Value>
            <Type>string</Type>
            <Operand>string</Operand>
            <Operator>string</Operator>
            <Editable>boolean</Editable>
          </Filter>
        </Filters>
      </Request>
    </Reports_Execute>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Reports_ExecuteResponse xmlns="http://api.myh2o.com/v20">
      <Reports_ExecuteResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <ReportID>int</ReportID>
            <ClearCache>boolean</ClearCache>
            <Format>CSV or XML</Format>
            <Compression>NONE or GZIP or ZIP</Compression>
            <Filters>
              <Filter>
                <ID>int</ID>
                <Column>string</Column>
                <Value>string</Value>
                <Type>string</Type>
                <Operand>string</Operand>
                <Operator>string</Operator>
                <Editable>boolean</Editable>
              </Filter>
              <Filter>
                <ID>int</ID>
                <Column>string</Column>
                <Value>string</Value>
                <Type>string</Type>
                <Operand>string</Operand>
                <Operator>string</Operator>
                <Editable>boolean</Editable>
              </Filter>
            </Filters>
          </Request>
        </Debug>
        <CSV>string</CSV>
        <XML>
          <Columns>
            <Column />
            <Column />
          </Columns>
          <Rows>
            <Cells>
              <Cell />
              <Cell />
            </Cells>
          </Rows>
          <Rows>
            <Cells>
              <Cell />
              <Cell />
            </Cells>
          </Rows>
        </XML>
        <Filename>string</Filename>
        <RowCount>int</RowCount>
      </Reports_ExecuteResult>
    </Reports_ExecuteResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <Reports_Execute xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <ReportID>int</ReportID>
        <ClearCache>boolean</ClearCache>
        <Format>CSV or XML</Format>
        <Compression>NONE or GZIP or ZIP</Compression>
        <Filters>
          <Filter>
            <ID>int</ID>
            <Column>string</Column>
            <Value>string</Value>
            <Type>string</Type>
            <Operand>string</Operand>
            <Operator>string</Operator>
            <Editable>boolean</Editable>
          </Filter>
          <Filter>
            <ID>int</ID>
            <Column>string</Column>
            <Value>string</Value>
            <Type>string</Type>
            <Operand>string</Operand>
            <Operator>string</Operator>
            <Editable>boolean</Editable>
          </Filter>
        </Filters>
      </Request>
    </Reports_Execute>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <Reports_ExecuteResponse xmlns="http://api.myh2o.com/v20">
      <Reports_ExecuteResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <ReportID>int</ReportID>
            <ClearCache>boolean</ClearCache>
            <Format>CSV or XML</Format>
            <Compression>NONE or GZIP or ZIP</Compression>
            <Filters>
              <Filter>
                <ID>int</ID>
                <Column>string</Column>
                <Value>string</Value>
                <Type>string</Type>
                <Operand>string</Operand>
                <Operator>string</Operator>
                <Editable>boolean</Editable>
              </Filter>
              <Filter>
                <ID>int</ID>
                <Column>string</Column>
                <Value>string</Value>
                <Type>string</Type>
                <Operand>string</Operand>
                <Operator>string</Operator>
                <Editable>boolean</Editable>
              </Filter>
            </Filters>
          </Request>
        </Debug>
        <CSV>string</CSV>
        <XML>
          <Columns>
            <Column />
            <Column />
          </Columns>
          <Rows>
            <Cells>
              <Cell />
              <Cell />
            </Cells>
          </Rows>
          <Rows>
            <Cells>
              <Cell />
              <Cell />
            </Cells>
          </Rows>
        </XML>
        <Filename>string</Filename>
        <RowCount>int</RowCount>
      </Reports_ExecuteResult>
    </Reports_ExecuteResponse>
  </soap12:Body>
</soap12:Envelope>