H2OAPIv20


Click here for a complete list of operations.

Contacts_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/Contacts_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>
    <Contacts_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>
        <ContactID>int</ContactID>
        <CustomerID>int</CustomerID>
      </Request>
    </Contacts_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>
    <Contacts_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Contacts_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>
            <ContactID>int</ContactID>
            <CustomerID>int</CustomerID>
          </Request>
        </Debug>
        <Contacts>
          <ContactItem>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <Name>string</Name>
            <Phone>string</Phone>
            <Mobile>string</Mobile>
            <Fax>string</Fax>
            <Email>string</Email>
            <Contact_Type_ID>int</Contact_Type_ID>
            <Contact_Type>string</Contact_Type>
            <Address>
              <ID>int</ID>
              <FirstName>string</FirstName>
              <LastName>string</LastName>
              <MiddleName>string</MiddleName>
              <Suffix>string</Suffix>
              <CompanyName>string</CompanyName>
              <Address1>string</Address1>
              <Address2>string</Address2>
              <City>string</City>
              <State>string</State>
              <Zip>string</Zip>
              <Zip4>string</Zip4>
              <Country>AFG or ALA or ALB or DZA or ASM or AND or AGO or AIA or ATA or ATG or ARG or ARM or ABW or AUS or AUT or AZE or BHS or BHR or BGD or BRB or BLR or BEL or BLZ or BEN or BMU or BTN or BOL or BES or BIH or BWA or BVT or BRA or IOT or BRN or BGR or BFA or BDI or CPV or KHM or CMR or CAN or CYM or CAF or TCD or CHL or CHN or CXR or CCK or COL or COM or COG or COD or COK or CRI or CIV or HRV or CUB or CUW or CYP or CZE or DNK or DJI or DMA or DOM or ECU or EGY or SLV or GNQ or ERI or EST or ETH or FLK or FRO or FJI or FIN or FRA or GUF or PYF or ATF or GAB or GMB or GEO or DEU or GHA or GIB or GRC or GRL or GRD or GLP or GUM or GTM or GGY or GIN or GNB or GUY or HTI or HMD or VAT or HND or HKG or HUN or ISL or IND or IDN or IRN or IRQ or IRL or IMN or ISR or ITA or JAM or JPN or JEY or JOR or KAZ or KEN or KIR or PRK or KOR or XKX or KWT or KGZ or LAO or LVA or LBN or LSO or LBR or LBY or LIE or LTU or LUX or MAC or MKD or MDG or MWI or MYS or MDV or MLI or MLT or MHL or MTQ or MRT or MUS or MYT or MEX or FSM or MDA or MCO or MNG or MNE or MSR or MAR or MOZ or MMR or NAM or NRU or NPL or NLD or NCL or NZL or NIC or NER or NGA or NIU or NFK or MNP or NOR or OMN or PAK or PLW or PSE or PAN or PNG or PRY or PER or PHL or PCN or POL or PRT or PRI or QAT or REU or ROU or RUS or RWA or BLM or SHN or KNA or LCA or MAF or SPM or VCT or WSM or SMR or STP or SAU or SEN or SRB or SYC or SLE or SGP or SXM or SVK or SVN or SLB or SOM or ZAF or SGS or SSD or ESP or LKA or SDN or SUR or SJM or SWZ or SWE or CHE or SYR or TWN or TJK or TZA or THA or TLS or TGO or TKL or TON or TTO or TUN or TUR or TKM or TCA or TUV or UGA or UKR or ARE or GBR or USA or UMI or URY or UZB or VUT or VEN or VNM or VGB or VIR or WLF or ESH or YEM or ZMB or ZWE</Country>
            </Address>
          </ContactItem>
          <ContactItem>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <Name>string</Name>
            <Phone>string</Phone>
            <Mobile>string</Mobile>
            <Fax>string</Fax>
            <Email>string</Email>
            <Contact_Type_ID>int</Contact_Type_ID>
            <Contact_Type>string</Contact_Type>
            <Address>
              <ID>int</ID>
              <FirstName>string</FirstName>
              <LastName>string</LastName>
              <MiddleName>string</MiddleName>
              <Suffix>string</Suffix>
              <CompanyName>string</CompanyName>
              <Address1>string</Address1>
              <Address2>string</Address2>
              <City>string</City>
              <State>string</State>
              <Zip>string</Zip>
              <Zip4>string</Zip4>
              <Country>AFG or ALA or ALB or DZA or ASM or AND or AGO or AIA or ATA or ATG or ARG or ARM or ABW or AUS or AUT or AZE or BHS or BHR or BGD or BRB or BLR or BEL or BLZ or BEN or BMU or BTN or BOL or BES or BIH or BWA or BVT or BRA or IOT or BRN or BGR or BFA or BDI or CPV or KHM or CMR or CAN or CYM or CAF or TCD or CHL or CHN or CXR or CCK or COL or COM or COG or COD or COK or CRI or CIV or HRV or CUB or CUW or CYP or CZE or DNK or DJI or DMA or DOM or ECU or EGY or SLV or GNQ or ERI or EST or ETH or FLK or FRO or FJI or FIN or FRA or GUF or PYF or ATF or GAB or GMB or GEO or DEU or GHA or GIB or GRC or GRL or GRD or GLP or GUM or GTM or GGY or GIN or GNB or GUY or HTI or HMD or VAT or HND or HKG or HUN or ISL or IND or IDN or IRN or IRQ or IRL or IMN or ISR or ITA or JAM or JPN or JEY or JOR or KAZ or KEN or KIR or PRK or KOR or XKX or KWT or KGZ or LAO or LVA or LBN or LSO or LBR or LBY or LIE or LTU or LUX or MAC or MKD or MDG or MWI or MYS or MDV or MLI or MLT or MHL or MTQ or MRT or MUS or MYT or MEX or FSM or MDA or MCO or MNG or MNE or MSR or MAR or MOZ or MMR or NAM or NRU or NPL or NLD or NCL or NZL or NIC or NER or NGA or NIU or NFK or MNP or NOR or OMN or PAK or PLW or PSE or PAN or PNG or PRY or PER or PHL or PCN or POL or PRT or PRI or QAT or REU or ROU or RUS or RWA or BLM or SHN or KNA or LCA or MAF or SPM or VCT or WSM or SMR or STP or SAU or SEN or SRB or SYC or SLE or SGP or SXM or SVK or SVN or SLB or SOM or ZAF or SGS or SSD or ESP or LKA or SDN or SUR or SJM or SWZ or SWE or CHE or SYR or TWN or TJK or TZA or THA or TLS or TGO or TKL or TON or TTO or TUN or TUR or TKM or TCA or TUV or UGA or UKR or ARE or GBR or USA or UMI or URY or UZB or VUT or VEN or VNM or VGB or VIR or WLF or ESH or YEM or ZMB or ZWE</Country>
            </Address>
          </ContactItem>
        </Contacts>
      </Contacts_QueryResult>
    </Contacts_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>
    <Contacts_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>
        <ContactID>int</ContactID>
        <CustomerID>int</CustomerID>
      </Request>
    </Contacts_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>
    <Contacts_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Contacts_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>
            <ContactID>int</ContactID>
            <CustomerID>int</CustomerID>
          </Request>
        </Debug>
        <Contacts>
          <ContactItem>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <Name>string</Name>
            <Phone>string</Phone>
            <Mobile>string</Mobile>
            <Fax>string</Fax>
            <Email>string</Email>
            <Contact_Type_ID>int</Contact_Type_ID>
            <Contact_Type>string</Contact_Type>
            <Address>
              <ID>int</ID>
              <FirstName>string</FirstName>
              <LastName>string</LastName>
              <MiddleName>string</MiddleName>
              <Suffix>string</Suffix>
              <CompanyName>string</CompanyName>
              <Address1>string</Address1>
              <Address2>string</Address2>
              <City>string</City>
              <State>string</State>
              <Zip>string</Zip>
              <Zip4>string</Zip4>
              <Country>AFG or ALA or ALB or DZA or ASM or AND or AGO or AIA or ATA or ATG or ARG or ARM or ABW or AUS or AUT or AZE or BHS or BHR or BGD or BRB or BLR or BEL or BLZ or BEN or BMU or BTN or BOL or BES or BIH or BWA or BVT or BRA or IOT or BRN or BGR or BFA or BDI or CPV or KHM or CMR or CAN or CYM or CAF or TCD or CHL or CHN or CXR or CCK or COL or COM or COG or COD or COK or CRI or CIV or HRV or CUB or CUW or CYP or CZE or DNK or DJI or DMA or DOM or ECU or EGY or SLV or GNQ or ERI or EST or ETH or FLK or FRO or FJI or FIN or FRA or GUF or PYF or ATF or GAB or GMB or GEO or DEU or GHA or GIB or GRC or GRL or GRD or GLP or GUM or GTM or GGY or GIN or GNB or GUY or HTI or HMD or VAT or HND or HKG or HUN or ISL or IND or IDN or IRN or IRQ or IRL or IMN or ISR or ITA or JAM or JPN or JEY or JOR or KAZ or KEN or KIR or PRK or KOR or XKX or KWT or KGZ or LAO or LVA or LBN or LSO or LBR or LBY or LIE or LTU or LUX or MAC or MKD or MDG or MWI or MYS or MDV or MLI or MLT or MHL or MTQ or MRT or MUS or MYT or MEX or FSM or MDA or MCO or MNG or MNE or MSR or MAR or MOZ or MMR or NAM or NRU or NPL or NLD or NCL or NZL or NIC or NER or NGA or NIU or NFK or MNP or NOR or OMN or PAK or PLW or PSE or PAN or PNG or PRY or PER or PHL or PCN or POL or PRT or PRI or QAT or REU or ROU or RUS or RWA or BLM or SHN or KNA or LCA or MAF or SPM or VCT or WSM or SMR or STP or SAU or SEN or SRB or SYC or SLE or SGP or SXM or SVK or SVN or SLB or SOM or ZAF or SGS or SSD or ESP or LKA or SDN or SUR or SJM or SWZ or SWE or CHE or SYR or TWN or TJK or TZA or THA or TLS or TGO or TKL or TON or TTO or TUN or TUR or TKM or TCA or TUV or UGA or UKR or ARE or GBR or USA or UMI or URY or UZB or VUT or VEN or VNM or VGB or VIR or WLF or ESH or YEM or ZMB or ZWE</Country>
            </Address>
          </ContactItem>
          <ContactItem>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <Name>string</Name>
            <Phone>string</Phone>
            <Mobile>string</Mobile>
            <Fax>string</Fax>
            <Email>string</Email>
            <Contact_Type_ID>int</Contact_Type_ID>
            <Contact_Type>string</Contact_Type>
            <Address>
              <ID>int</ID>
              <FirstName>string</FirstName>
              <LastName>string</LastName>
              <MiddleName>string</MiddleName>
              <Suffix>string</Suffix>
              <CompanyName>string</CompanyName>
              <Address1>string</Address1>
              <Address2>string</Address2>
              <City>string</City>
              <State>string</State>
              <Zip>string</Zip>
              <Zip4>string</Zip4>
              <Country>AFG or ALA or ALB or DZA or ASM or AND or AGO or AIA or ATA or ATG or ARG or ARM or ABW or AUS or AUT or AZE or BHS or BHR or BGD or BRB or BLR or BEL or BLZ or BEN or BMU or BTN or BOL or BES or BIH or BWA or BVT or BRA or IOT or BRN or BGR or BFA or BDI or CPV or KHM or CMR or CAN or CYM or CAF or TCD or CHL or CHN or CXR or CCK or COL or COM or COG or COD or COK or CRI or CIV or HRV or CUB or CUW or CYP or CZE or DNK or DJI or DMA or DOM or ECU or EGY or SLV or GNQ or ERI or EST or ETH or FLK or FRO or FJI or FIN or FRA or GUF or PYF or ATF or GAB or GMB or GEO or DEU or GHA or GIB or GRC or GRL or GRD or GLP or GUM or GTM or GGY or GIN or GNB or GUY or HTI or HMD or VAT or HND or HKG or HUN or ISL or IND or IDN or IRN or IRQ or IRL or IMN or ISR or ITA or JAM or JPN or JEY or JOR or KAZ or KEN or KIR or PRK or KOR or XKX or KWT or KGZ or LAO or LVA or LBN or LSO or LBR or LBY or LIE or LTU or LUX or MAC or MKD or MDG or MWI or MYS or MDV or MLI or MLT or MHL or MTQ or MRT or MUS or MYT or MEX or FSM or MDA or MCO or MNG or MNE or MSR or MAR or MOZ or MMR or NAM or NRU or NPL or NLD or NCL or NZL or NIC or NER or NGA or NIU or NFK or MNP or NOR or OMN or PAK or PLW or PSE or PAN or PNG or PRY or PER or PHL or PCN or POL or PRT or PRI or QAT or REU or ROU or RUS or RWA or BLM or SHN or KNA or LCA or MAF or SPM or VCT or WSM or SMR or STP or SAU or SEN or SRB or SYC or SLE or SGP or SXM or SVK or SVN or SLB or SOM or ZAF or SGS or SSD or ESP or LKA or SDN or SUR or SJM or SWZ or SWE or CHE or SYR or TWN or TJK or TZA or THA or TLS or TGO or TKL or TON or TTO or TUN or TUR or TKM or TCA or TUV or UGA or UKR or ARE or GBR or USA or UMI or URY or UZB or VUT or VEN or VNM or VGB or VIR or WLF or ESH or YEM or ZMB or ZWE</Country>
            </Address>
          </ContactItem>
        </Contacts>
      </Contacts_QueryResult>
    </Contacts_QueryResponse>
  </soap12:Body>
</soap12:Envelope>