H2OAPIv20


Click here for a complete list of operations.

Duplicate_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/Duplicate_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>
    <Duplicate_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>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleName>string</MiddleName>
        <Suffix>string</Suffix>
        <SSNTaxId>string</SSNTaxId>
        <SSNTaxIdLast4>string</SSNTaxIdLast4>
        <DateOfBirth>dateTime</DateOfBirth>
        <DriversLicenseNumber>string</DriversLicenseNumber>
        <Street1>string</Street1>
        <Street2>string</Street2>
        <City>string</City>
        <State>string</State>
        <Zip>string</Zip>
        <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
        <OptionMatchPatterns>
          <string>string</string>
          <string>string</string>
        </OptionMatchPatterns>
        <OptionBillProfileIDs>
          <int>int</int>
          <int>int</int>
        </OptionBillProfileIDs>
        <OptionLifelinePrograms>
          <string>string</string>
          <string>string</string>
        </OptionLifelinePrograms>
      </Request>
    </Duplicate_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>
    <Duplicate_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Duplicate_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>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <Suffix>string</Suffix>
            <SSNTaxId>string</SSNTaxId>
            <SSNTaxIdLast4>string</SSNTaxIdLast4>
            <DateOfBirth>dateTime</DateOfBirth>
            <DriversLicenseNumber>string</DriversLicenseNumber>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
            <OptionMatchPatterns>
              <string>string</string>
              <string>string</string>
            </OptionMatchPatterns>
            <OptionBillProfileIDs>
              <int>int</int>
              <int>int</int>
            </OptionBillProfileIDs>
            <OptionLifelinePrograms>
              <string>string</string>
              <string>string</string>
            </OptionLifelinePrograms>
          </Request>
        </Debug>
        <MatchTotalCount>int</MatchTotalCount>
        <MatchPersonCount>int</MatchPersonCount>
        <MatchLocationCount>int</MatchLocationCount>
        <Matches>
          <Duplicate_Query_Match>
            <MatchPatterns>
              <string>string</string>
              <string>string</string>
            </MatchPatterns>
            <MatchType>PERSON or LOCATION</MatchType>
            <CustomerID>int</CustomerID>
            <AcctNum>string</AcctNum>
            <Name>string</Name>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <CityStateZip>string</CityStateZip>
            <Status>ALL or PROSPECT or PENDING or CLOSED or OPEN</Status>
            <Created_Date>dateTime</Created_Date>
            <LifelineProgram>string</LifelineProgram>
          </Duplicate_Query_Match>
          <Duplicate_Query_Match>
            <MatchPatterns>
              <string>string</string>
              <string>string</string>
            </MatchPatterns>
            <MatchType>PERSON or LOCATION</MatchType>
            <CustomerID>int</CustomerID>
            <AcctNum>string</AcctNum>
            <Name>string</Name>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <CityStateZip>string</CityStateZip>
            <Status>ALL or PROSPECT or PENDING or CLOSED or OPEN</Status>
            <Created_Date>dateTime</Created_Date>
            <LifelineProgram>string</LifelineProgram>
          </Duplicate_Query_Match>
        </Matches>
        <Request>
          <Credentials>
            <Username>string</Username>
            <Password>string</Password>
            <Client>string</Client>
            <ImpersonationKey>string</ImpersonationKey>
          </Credentials>
          <Session>
            <SessionKey>string</SessionKey>
          </Session>
          <Debug>boolean</Debug>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <Suffix>string</Suffix>
          <SSNTaxId>string</SSNTaxId>
          <SSNTaxIdLast4>string</SSNTaxIdLast4>
          <DateOfBirth>dateTime</DateOfBirth>
          <DriversLicenseNumber>string</DriversLicenseNumber>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
          <OptionMatchPatterns>
            <string>string</string>
            <string>string</string>
          </OptionMatchPatterns>
          <OptionBillProfileIDs>
            <int>int</int>
            <int>int</int>
          </OptionBillProfileIDs>
          <OptionLifelinePrograms>
            <string>string</string>
            <string>string</string>
          </OptionLifelinePrograms>
        </Request>
      </Duplicate_QueryResult>
    </Duplicate_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>
    <Duplicate_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>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleName>string</MiddleName>
        <Suffix>string</Suffix>
        <SSNTaxId>string</SSNTaxId>
        <SSNTaxIdLast4>string</SSNTaxIdLast4>
        <DateOfBirth>dateTime</DateOfBirth>
        <DriversLicenseNumber>string</DriversLicenseNumber>
        <Street1>string</Street1>
        <Street2>string</Street2>
        <City>string</City>
        <State>string</State>
        <Zip>string</Zip>
        <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
        <OptionMatchPatterns>
          <string>string</string>
          <string>string</string>
        </OptionMatchPatterns>
        <OptionBillProfileIDs>
          <int>int</int>
          <int>int</int>
        </OptionBillProfileIDs>
        <OptionLifelinePrograms>
          <string>string</string>
          <string>string</string>
        </OptionLifelinePrograms>
      </Request>
    </Duplicate_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>
    <Duplicate_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Duplicate_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>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <Suffix>string</Suffix>
            <SSNTaxId>string</SSNTaxId>
            <SSNTaxIdLast4>string</SSNTaxIdLast4>
            <DateOfBirth>dateTime</DateOfBirth>
            <DriversLicenseNumber>string</DriversLicenseNumber>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
            <OptionMatchPatterns>
              <string>string</string>
              <string>string</string>
            </OptionMatchPatterns>
            <OptionBillProfileIDs>
              <int>int</int>
              <int>int</int>
            </OptionBillProfileIDs>
            <OptionLifelinePrograms>
              <string>string</string>
              <string>string</string>
            </OptionLifelinePrograms>
          </Request>
        </Debug>
        <MatchTotalCount>int</MatchTotalCount>
        <MatchPersonCount>int</MatchPersonCount>
        <MatchLocationCount>int</MatchLocationCount>
        <Matches>
          <Duplicate_Query_Match>
            <MatchPatterns>
              <string>string</string>
              <string>string</string>
            </MatchPatterns>
            <MatchType>PERSON or LOCATION</MatchType>
            <CustomerID>int</CustomerID>
            <AcctNum>string</AcctNum>
            <Name>string</Name>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <CityStateZip>string</CityStateZip>
            <Status>ALL or PROSPECT or PENDING or CLOSED or OPEN</Status>
            <Created_Date>dateTime</Created_Date>
            <LifelineProgram>string</LifelineProgram>
          </Duplicate_Query_Match>
          <Duplicate_Query_Match>
            <MatchPatterns>
              <string>string</string>
              <string>string</string>
            </MatchPatterns>
            <MatchType>PERSON or LOCATION</MatchType>
            <CustomerID>int</CustomerID>
            <AcctNum>string</AcctNum>
            <Name>string</Name>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <CityStateZip>string</CityStateZip>
            <Status>ALL or PROSPECT or PENDING or CLOSED or OPEN</Status>
            <Created_Date>dateTime</Created_Date>
            <LifelineProgram>string</LifelineProgram>
          </Duplicate_Query_Match>
        </Matches>
        <Request>
          <Credentials>
            <Username>string</Username>
            <Password>string</Password>
            <Client>string</Client>
            <ImpersonationKey>string</ImpersonationKey>
          </Credentials>
          <Session>
            <SessionKey>string</SessionKey>
          </Session>
          <Debug>boolean</Debug>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <Suffix>string</Suffix>
          <SSNTaxId>string</SSNTaxId>
          <SSNTaxIdLast4>string</SSNTaxIdLast4>
          <DateOfBirth>dateTime</DateOfBirth>
          <DriversLicenseNumber>string</DriversLicenseNumber>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <OptionIgnoreClosed>boolean</OptionIgnoreClosed>
          <OptionMatchPatterns>
            <string>string</string>
            <string>string</string>
          </OptionMatchPatterns>
          <OptionBillProfileIDs>
            <int>int</int>
            <int>int</int>
          </OptionBillProfileIDs>
          <OptionLifelinePrograms>
            <string>string</string>
            <string>string</string>
          </OptionLifelinePrograms>
        </Request>
      </Duplicate_QueryResult>
    </Duplicate_QueryResponse>
  </soap12:Body>
</soap12:Envelope>