H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

Lines_Update

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

<?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>
    <Lines_Update 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>
        <Line_ID>int</Line_ID>
        <Number>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Number>
        <Circuit_Number>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Circuit_Number>
        <Carrier_Customer_Id>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Carrier_Customer_Id>
        <Description>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Description>
        <Program_ID>
          <Updated>boolean</Updated>
          <Value>int</Value>
        </Program_ID>
        <Line_Type_Id>
          <Updated>boolean</Updated>
          <Value>int</Value>
        </Line_Type_Id>
        <Fields>
          <Field>
            <Label>string</Label>
            <Value>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Value>
          </Field>
          <Field>
            <Label>string</Label>
            <Value>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Value>
          </Field>
        </Fields>
      </Request>
    </Lines_Update>
  </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>
    <Lines_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Lines_UpdateResult>
        <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>
            <Line_ID>int</Line_ID>
            <Number>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Number>
            <Circuit_Number>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Circuit_Number>
            <Carrier_Customer_Id>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Carrier_Customer_Id>
            <Description>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Description>
            <Program_ID>
              <Updated>boolean</Updated>
              <Value>int</Value>
            </Program_ID>
            <Line_Type_Id>
              <Updated>boolean</Updated>
              <Value>int</Value>
            </Line_Type_Id>
            <Fields>
              <Field>
                <Label>string</Label>
                <Value>
                  <Updated>boolean</Updated>
                  <Value>string</Value>
                </Value>
              </Field>
              <Field>
                <Label>string</Label>
                <Value>
                  <Updated>boolean</Updated>
                  <Value>string</Value>
                </Value>
              </Field>
            </Fields>
          </Request>
        </Debug>
      </Lines_UpdateResult>
    </Lines_UpdateResponse>
  </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>
    <Lines_Update 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>
        <Line_ID>int</Line_ID>
        <Number>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Number>
        <Circuit_Number>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Circuit_Number>
        <Carrier_Customer_Id>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Carrier_Customer_Id>
        <Description>
          <Updated>boolean</Updated>
          <Value>string</Value>
        </Description>
        <Program_ID>
          <Updated>boolean</Updated>
          <Value>int</Value>
        </Program_ID>
        <Line_Type_Id>
          <Updated>boolean</Updated>
          <Value>int</Value>
        </Line_Type_Id>
        <Fields>
          <Field>
            <Label>string</Label>
            <Value>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Value>
          </Field>
          <Field>
            <Label>string</Label>
            <Value>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Value>
          </Field>
        </Fields>
      </Request>
    </Lines_Update>
  </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>
    <Lines_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Lines_UpdateResult>
        <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>
            <Line_ID>int</Line_ID>
            <Number>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Number>
            <Circuit_Number>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Circuit_Number>
            <Carrier_Customer_Id>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Carrier_Customer_Id>
            <Description>
              <Updated>boolean</Updated>
              <Value>string</Value>
            </Description>
            <Program_ID>
              <Updated>boolean</Updated>
              <Value>int</Value>
            </Program_ID>
            <Line_Type_Id>
              <Updated>boolean</Updated>
              <Value>int</Value>
            </Line_Type_Id>
            <Fields>
              <Field>
                <Label>string</Label>
                <Value>
                  <Updated>boolean</Updated>
                  <Value>string</Value>
                </Value>
              </Field>
              <Field>
                <Label>string</Label>
                <Value>
                  <Updated>boolean</Updated>
                  <Value>string</Value>
                </Value>
              </Field>
            </Fields>
          </Request>
        </Debug>
      </Lines_UpdateResult>
    </Lines_UpdateResponse>
  </soap12:Body>
</soap12:Envelope>