H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

CustomerProducts_Query

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/CustomerProducts_Query"

<?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>
    <CustomerProducts_Query 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>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <LineID>int</LineID>
        <LineID>int</LineID>
        <ID>int</ID>
        <ID>int</ID>
      </Request>
    </CustomerProducts_Query>
  </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>
    <CustomerProducts_QueryResponse xmlns="http://api.myh2o.com/v20">
      <CustomerProducts_QueryResult>
        <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>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <LineID>int</LineID>
            <LineID>int</LineID>
            <ID>int</ID>
            <ID>int</ID>
          </Request>
        </Debug>
        <CustomerProducts>
          <CustomerProduct>
            <Customer_Product_ID>int</Customer_Product_ID>
            <Line_ID>int</Line_ID>
            <Customer_ID>int</Customer_ID>
            <Product_ID>int</Product_ID>
            <Description>string</Description>
            <Group_On_Bill>boolean</Group_On_Bill>
            <Tax_Included>boolean</Tax_Included>
            <Quantity>int</Quantity>
            <Rate>decimal</Rate>
            <Cost>decimal</Cost>
            <Package_ID>int</Package_ID>
            <Package>string</Package>
            <Code1>string</Code1>
            <Code2>string</Code2>
            <Status>PENDING or ACTIVE or DENIED or DISCONNECTED</Status>
            <Carrier>string</Carrier>
            <Carrier_ID>int</Carrier_ID>
            <Activated_Date>dateTime</Activated_Date>
            <Billed_Through_Date>dateTime</Billed_Through_Date>
            <Canceled_Date>dateTime</Canceled_Date>
            <Disconnect_Date>dateTime</Disconnect_Date>
          </CustomerProduct>
          <CustomerProduct>
            <Customer_Product_ID>int</Customer_Product_ID>
            <Line_ID>int</Line_ID>
            <Customer_ID>int</Customer_ID>
            <Product_ID>int</Product_ID>
            <Description>string</Description>
            <Group_On_Bill>boolean</Group_On_Bill>
            <Tax_Included>boolean</Tax_Included>
            <Quantity>int</Quantity>
            <Rate>decimal</Rate>
            <Cost>decimal</Cost>
            <Package_ID>int</Package_ID>
            <Package>string</Package>
            <Code1>string</Code1>
            <Code2>string</Code2>
            <Status>PENDING or ACTIVE or DENIED or DISCONNECTED</Status>
            <Carrier>string</Carrier>
            <Carrier_ID>int</Carrier_ID>
            <Activated_Date>dateTime</Activated_Date>
            <Billed_Through_Date>dateTime</Billed_Through_Date>
            <Canceled_Date>dateTime</Canceled_Date>
            <Disconnect_Date>dateTime</Disconnect_Date>
          </CustomerProduct>
        </CustomerProducts>
      </CustomerProducts_QueryResult>
    </CustomerProducts_QueryResponse>
  </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>
    <CustomerProducts_Query 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>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <LineID>int</LineID>
        <LineID>int</LineID>
        <ID>int</ID>
        <ID>int</ID>
      </Request>
    </CustomerProducts_Query>
  </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>
    <CustomerProducts_QueryResponse xmlns="http://api.myh2o.com/v20">
      <CustomerProducts_QueryResult>
        <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>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <LineID>int</LineID>
            <LineID>int</LineID>
            <ID>int</ID>
            <ID>int</ID>
          </Request>
        </Debug>
        <CustomerProducts>
          <CustomerProduct>
            <Customer_Product_ID>int</Customer_Product_ID>
            <Line_ID>int</Line_ID>
            <Customer_ID>int</Customer_ID>
            <Product_ID>int</Product_ID>
            <Description>string</Description>
            <Group_On_Bill>boolean</Group_On_Bill>
            <Tax_Included>boolean</Tax_Included>
            <Quantity>int</Quantity>
            <Rate>decimal</Rate>
            <Cost>decimal</Cost>
            <Package_ID>int</Package_ID>
            <Package>string</Package>
            <Code1>string</Code1>
            <Code2>string</Code2>
            <Status>PENDING or ACTIVE or DENIED or DISCONNECTED</Status>
            <Carrier>string</Carrier>
            <Carrier_ID>int</Carrier_ID>
            <Activated_Date>dateTime</Activated_Date>
            <Billed_Through_Date>dateTime</Billed_Through_Date>
            <Canceled_Date>dateTime</Canceled_Date>
            <Disconnect_Date>dateTime</Disconnect_Date>
          </CustomerProduct>
          <CustomerProduct>
            <Customer_Product_ID>int</Customer_Product_ID>
            <Line_ID>int</Line_ID>
            <Customer_ID>int</Customer_ID>
            <Product_ID>int</Product_ID>
            <Description>string</Description>
            <Group_On_Bill>boolean</Group_On_Bill>
            <Tax_Included>boolean</Tax_Included>
            <Quantity>int</Quantity>
            <Rate>decimal</Rate>
            <Cost>decimal</Cost>
            <Package_ID>int</Package_ID>
            <Package>string</Package>
            <Code1>string</Code1>
            <Code2>string</Code2>
            <Status>PENDING or ACTIVE or DENIED or DISCONNECTED</Status>
            <Carrier>string</Carrier>
            <Carrier_ID>int</Carrier_ID>
            <Activated_Date>dateTime</Activated_Date>
            <Billed_Through_Date>dateTime</Billed_Through_Date>
            <Canceled_Date>dateTime</Canceled_Date>
            <Disconnect_Date>dateTime</Disconnect_Date>
          </CustomerProduct>
        </CustomerProducts>
      </CustomerProducts_QueryResult>
    </CustomerProducts_QueryResponse>
  </soap12:Body>
</soap12:Envelope>