CarrierAuth

Use the CarrierAuth web service to get, configure, modify, or delete carrier account credentials.

URI

http://<hostname>/ws/CarrierAuth

Formats

HTTP method	Format	Description
GET	/ws/CarrierAuth	Get a list of all configured carrier accounts.Note Password information is not returned.
POST	/ws/CarrierAuth	Configure authorization information for a carrier account.
PUT	/ws/CarrierAuth/{caId}	Update carrier authorization information for an existing carrier account.
DELETE	/ws/CarrierAuth/{caId}	Delete carrier authorization information for a carrier account.

Elements

caId

Identifier associated with a specific carrier authentication. A unique identifier is returned for each CarrierAuth request.

cstId

Remote Manager identifier for the customer.

prvName

Cellular service provider name. Options include: ATT, DeutscheTelekom, Rogers, Telefonica, Verizon, or Vodafone.

caUserName

Username associated with the carrier account. This is the username provided by your business account carrier that you used to set up the carrier account within Remote Manager.

caPassword

Password for the cellular service account. This password was provided by your business account carrier.

caUpdateTime

Date and time in ISO 8601 format when your carrier account information was last updated.

caLicenseKey1

Admintrator license key required for AT&T, Rogers, and Telefonica.

Get All Carrier Accounts

The following example shows how to get a list of configured carrier accounts for your Remote Manager account.

Note Password information is not retured.

Request

GET ws/CarrierAuth

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<result>
  <resultTotalRows>2</resultTotalRows>
  <requestedStartRow>0</requestedStartRow>
  <resultSize>2</resultSize>
  <requestedSize>1000</requestedSize>
  <remainingSize>0</remainingSize>
  <CarrierAuth>
    <caId>2</caId>
    <cstId>3</cstId>
    <prvName>ATT</prvName>  <!-- carrier account #1 -->
    <caUserName>exampleUser</caUserName>
    <caUpdateTime>2012-10-15T15:17:00.000Z</caUpdateTime>
  </CarrierAuth>
  <CarrierAuth>
    <caId>67</caId>
    <cstId>3</cstId>
    <prvName>Vodafone</prvName>    <!-- carrier account #2 -->
    <caUserName>exampleUser</caUserName>
    <caUpdateTime>2012-10-31T18:55:00.000Z</caUpdateTime>
  </CarrierAuth>
</result>

Configure Carrier Account Credentials

The following example shows how to configure credentials for an AT&T account.

POST /ws/CarrierAuth
<CarrierAuth>
   <prvName>ATT</prvName> 
   <caUserName>ExampleUser</caUserName>
   <caPassword>123</caPassword>
   <caLicenseKey1>123</caLicenseKey1>
 </CarrierAuth>

Update a Carrier Account

The following example shows how to insert a caId element in an existing AT&T account.

PUT /ws/CarrierAuth
<CarrierAuth>
   <caId>7</caId>
   <prvName>ATT</prvName> 
   <caUserName>exampleUser</caUserName>
   <caPassword>123</caPassword>
   <caLicenseKey1>123</caLicenseKey1>
 </CarrierAuth>

Delete Carrier Account

The following example shows how to delete the record of a carrier account in Remote Manager.

DELETE ws/CarrierAuth/{subscription_id}

Replace subscription_id with the subscription ID of the account you want to delete.