Lines

Lines_PackageChange

Used to change the package of a service in Rev.io.

Input Fields

Field	Type	Notes	Required?
LineId	Integer	The Rev.io ID of the service that is having the package changed performed.	Required
PackageID	Integer	The Rev.io ID of the package being changed on the service.	Required
EffectiveDate	Date	The effective date of the package change. If not specified, today's date is used.	Optional
CarrierAccountID	Integer	The Rev.io ID of the provider account to be changed along with the package change. If not specified, the default using the package provider and service address is used.	Optional
ProgramID	Integer	The Rev.io ID of the usage plan group to be used with the new package change. If not specified, the usage plan group on the package is used.	Optional

Output Fields

No fields other than the standard output fields are provided.

Example Requests

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <Lines_PackageChange xmlns="http://api.myh2o.com/v20">
            <Request>
                <Credentials>
                    <Username>rev.io_username</Username>
                    <Password>rev.io_password</Password>
                    <Client>rev.io_client_code</Client>
                </Credentials>
                <LineID>123456</LineID>
                <PackageID>1001</PackageID>
                <ProgramID>0</ProgramID>
            </Request>
        </Lines_PackageChange>
    </soap:Body>
</soap:Envelope>

Example Responses

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_PackageChangeResponse xmlns="http://api.myh2o.com/v20">
      <Lines_PackageChangeResult>
        <Header>
          <Success>true</Success>
          <SessionKey>ABC123939AkD9kD9303odfABC123939AkD9kD9303odf</SessionKey>
          <Impersonated>false</Impersonated>
        </Header>
      </Lines_PackageChangeResult>
    </Lines_PackageChangeResponse>
  </soap:Body>
</soap:Envelope>

Lines_Query

Use to retrieve information regarding services on a customer's account in Rev.io.

Input Fields

Field	Type	Notes	Required?
CustomerID	List/Integer	One or more Rev.io Customer IDs. Multiple Customer IDs can be used in one request to save round-trips.	Optional
LineID	List/Ingeter	One or more Rev.io Service IDs. Multiple Service IDs can be used in one request to save round-trips.	Optional
Number	String	This is the built-in "TN" field on a Service in Rev.io. See notes below in the Output section for this field.	Optional
CircuitNumber	String	This is the built-in "Circuit Number" field on a Service in Rev.io. See notes below in the Output section for this field.	Optional
CarrierCustomerID	String	This is the built-in "Provider Account Number" field on a Service in Rev.io. See notes below in the Output section for this field.	Optional

Output Fields

Field	Type	Notes
Line_ID	Integer	Rev.io-generated unique identify for each Service.
Customer_ID	Integer	If you use Customer Account Numbers, this will not reflect that, but instead is the Rev.io-generated ID.
Number	String	This is the built-in "TN" field in Rev.io. Regardless of the type of service in Rev.io, this field is used to store the primary identifier for the service represented by this service. It should be unique throughout your system. (e.g. two customers should not have the same phone number or MAC address, etc). For example, for a calling card, this would be the calling card number; for email service, this would be the email address, etc. In our instance of Rev.io that we use for our internal billing, we store the client code in this field as that is how we uniquely identify each customer's service.
Circuit_Number	String	Another built-in field that can be used for identifying a service. It is similar to Number & Carrier_Customer_ID.
Carrier_Customer_ID	String	Another built-in field that can be used for identifying a service. It is similar to Number & Circuit_Number.
Description	String	Prints on a customer's bill. Typically used for a customer-facing friendly name to help the customer recognize the service. E.g. Alarm Service, Rebecca's Office Service, etc. With the Enterprise Customer Portal customers can maintain these and use them to help organize services.
Status	String	One of the following values: PENDING ACTIVE DENIED DISCONNECTED
Carrier	String	Description of the Provider assigned. If this is a service you are buying from a wholesale provider, that is what goes here typically (e.g. AT&T, Verizon, Sprint, Broadvox, etc). This can also be internal systems - e.g. Metaswitch, Asterisk, LD Switch, Acme Packet, etc. When orders are created in Rev.io, they will be split up by provider so it is an important part of your workflow to have this set appropriately.
Carrier_ID	Integer	ID of above
Carrier_Account	String	Depends on the Provider above, but will often be a sub-account - e.g. if Provider is AT&T, this may be AT&T Florida account. If Provider is Metaswitch, this may be the specific Metaswitch this Service is on - e.g. Metaswitch Boston 01, etc.
Carrier_Account_ID	Integer	ID of above
Package	String	Description of the Package assigned if applicable. Packages are configured under Settings > Packages.
Package_ID	Integer	ID of above
Program	String	Description of the usage plan group. Usage plan groups are configured under Settings > Usage Plan Groups. Usage plan groups contains plans, and plans contain rates. Rates are used in usage rating to charge for an individual call/event/message/etc.
Program_ID	Integer	ID of above
Line_Type	String	Description of Service Type - e.g. Fiber Internet, POTS Service, Conference Service, etc. Configured under Settings > Service Types.
Line_Type_ID	Integer	ID of above
Fields	List	List of all custom fields on this service. Configured under Settings > Service Types.
Fields > Label	String	Label from Rev.io that is displayed with the field's value
Fields > Value	String	Value of the field stored in Rev.io.

Example Requests

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <Lines_Query xmlns="http://api.myh2o.com/v20">
            <Request>
                <Credentials>
                    <Username>rev.io_username</Username>
                    <Password>rev.io_password</Password>
                    <Client>rev.io_client_code</Client>
                </Credentials>
                <CustomerID>1200</CustomerID>
                <CustomerID>1201</CustomerID>
                <CustomerID>1202</CustomerID>
                <CustomerID>3500</CustomerID>
            </Request>
        </Lines_Query>
    </soap:Body>
</soap:Envelope>

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <Lines_Query xmlns="http://api.myh2o.com/v20">
            <Request>
                <Credentials>
                    <Username>rev.io_username</Username>
                    <Password>rev.io_password</Password>
                    <Client>rev.io_client_code</Client>
                </Credentials>
                <LineID>9898</LineID>
            </Request>
        </Lines_Query>
    </soap:Body>
</soap:Envelope>

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <Lines_Query xmlns="http://api.myh2o.com/v20">
            <Request>
                <Credentials>
                    <Username>rev.io_username</Username>
                    <Password>rev.io_password</Password>
                    <Client>rev.io_client_code</Client>
                </Credentials>
                <Number>1200</Number>
            </Request>
        </Lines_Query>
    </soap:Body>
</soap:Envelope>

Example Responses

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Lines_QueryResult>
        <Header>
          <Success>true</Success>
          <SessionKey>ABC123939AkD9kD9303odfABC123939AkD9kD9303odf</SessionKey>
          <Impersonated>false</Impersonated>
        </Header>
        <Lines>
          <Line>
            <Line_ID>25001</Line_ID>
            <Customer_ID>9999</Customer_ID>
            <Number>4045551234</Number>
            <Circuit_Number/>
            <Carrier_Customer_Id/>
            <Description/>
            <Status>ACTIVE</Status>
            <Carrier>Inhouse</Carrier>
            <Carrier_ID>1000</Carrier_ID>
            <Carrier_Account>Default</Carrier_Account>
            <Carrier_Account_ID>1001</Carrier_Account_ID>
            <Package/>
            <Package_ID>0</Package_ID>
            <Program>Business Basic</Program>
            <Program_ID>100</Program_ID>
            <Line_Type>Virtual Extension</Line_Type>
            <Line_Type_ID>4</Line_Type_ID>
            <Fields/>
          </Line>
          <Line>
            <Line_ID>25000</Line_ID>
            <Customer_ID>9999</Customer_ID>
            <Number>192.31.214.65</Number>
            <Circuit_Number>68.118.33.50</Circuit_Number>
            <Carrier_Customer_Id/>
            <Description>Primary Internet</Description>
            <Status>ACTIVE</Status>
            <Carrier>Inhouse</Carrier>
            <Carrier_ID>1000</Carrier_ID>
            <Carrier_Account>Default</Carrier_Account>
            <Carrier_Account_ID>1001</Carrier_Account_ID>
            <Package>Fiber 10 Gbps</Package>
            <Package_ID>25</Package_ID>
            <Program>Business Basic</Program>
            <Program_ID>100</Program_ID>
            <Line_Type>Dedicated Internet Access</Line_Type>
            <Line_Type_ID>16</Line_Type_ID>
            <Fields>
              <Field>
                <Label>Speed</Label>
                <Value>10000</Value>
              </Field>
              <Field>
                <Label>Primary DNS</Label>
                <Value>8.8.4.4</Value>
              </Field>
              <Field>
                <Label>Secondary DNS</Label>
                <Value>4.4.4.4</Value>
              </Field>
            </Fields>
          </Line>
        </Lines>
      </Lines_QueryResult>
    </Lines_QueryResponse>
  </soap:Body>
</soap:Envelope>

Lines_Update

Update a Service in Rev.io by ID.

Input Fields

Field	Type	Notes	Required?
Line_ID	Integer	Rev.io Service ID of the Service to be updated.	Required
Number / Updated	Boolean	True to indicate this field is being updated.	Optional
Number / Value	String	This is the built-in "TN" field on a Service in Rev.io.	Optional
CircuitNumber / Updated	Boolean	True to indicate this field is being updated.	Optional
CircuitNumber / Value	String	This is the built-in "Circuit Number" field on a Service in Rev.io.	Optional
CarrierCustomerId / Updated	Boolean	True to indicate this field is being updated.	Optional
CarrierCustomerId / Value	String	This is the built-in "Provider Account Number" field on a Service in Rev.io.	Optional
Program_ID / Updated	Boolean	True to indicate this field is being updated.	Optional
Program_ID / Value	Integer	Rev.io ID of a usage plan group to be updated on the service.	Optional
Line_Type_ID / Updated	Boolean	True to indicate this field is being updated.	Optional
Line_Type_ID / Value	Integer	Rev.io Service Type ID of a service type to be updated on the service.	Optional
Fields / Field		One or more custom fields to be updated.	Optional
Fields / Field / Updated	Boolean	True to indicate this field is being updated.	Optional
Fields / Field / Value	String	Value to set on the custom field specified.	Optional

Output Fields

There are no additional fields beyond the standard header fields.

Example Requests

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_Update xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>rev.io_username</Username>
          <Password>rev.io_password</Password>
          <Client>rev.io_client_code</Client>
        </Credentials>
        <Line_ID>1393</Line_ID>
        <Number>
          <Updated>true</Updated>
          <Value>8509998877</Value>
        </Number>
      </Request>
    </Lines_Update>
  </soap:Body>
</soap:Envelope>

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_Update xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>rev.io_username</Username>
          <Password>rev.io_password</Password>
          <Client>rev.io_client_code</Client>
        </Credentials>
        <Line_ID>1393</Line_ID>
        <Number>
          <Updated>true</Updated>
          <Value>8509998877</Value>
        </Number>
        <Fields>
          <Field>
            <Label>Primary DNS</Label>
            <Value>
              <Updated>true</Updated>
              <Value>8.8.4.4</Value>
            </Value>
          </Field>
          <Field>
            <Label>Secondary DNS</Label>
            <Value>
              <Updated>true</Updated>
              <Value>4.4.4.4</Value>
            </Value>
          </Field>
        </Fields>
      </Request>
    </Lines_Update>
  </soap:Body>
</soap:Envelope>

Example Responses

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Lines_UpdateResult>
        <Header>
          <Success>false</Success>
          <Message>Field Primary DNS was not found.</Message>
          <Impersonated xsi:nil="true"/>
          <Error_Code>S2010</Error_Code>
          <Error_Description>Invalid input received.</Error_Description>
        </Header>
      </Lines_UpdateResult>
    </Lines_UpdateResponse>
  </soap:Body>
</soap:Envelope>

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <Lines_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Lines_UpdateResult>
        <Header>
          <Success>true</Success>
          <SessionKey>ABCdk38oeh30e9fABCdk38oeh30e9fABCdk38oeh30e9fABCdk38oeh30e9fABCdk38oeh30e9f</SessionKey>
          <Impersonated>false</Impersonated>
        </Header>
      </Lines_UpdateResult>
    </Lines_UpdateResponse>
  </soap:Body>
</soap:Envelope>

Updated 13 days ago