Get Frequency List API

Purpose

The Frequency List API is used to request the current list of Frequencies available and the value assigned to each. This list is used during using the Coverage Creation API so that a valid value is used to select a frequency.

Fields

Account

You can locate your Account ID in the API's Tab of your account settings and also within the iframe of your Multi Coverage.

API Key

Your API key can be located on the API's tab of your account settings. This is a required field and is what the API server will use to determine if you have sufficient API calls available on your account.

Code Examples

SOAP 1.1

Request

POST /towercoverage.asmx HTTP/1.1
Host: api.towercoverage.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetFrequencyList"

<?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>
    <GetFrequencyList 
xmlns="http://tempuri.org/">
      <Account>string</Account>
      <key>string</key>
    </GetFrequencyList>
  </soap:Body>
</soap:Envelope>

Response

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>
    <GetFrequencyListResponse 
xmlns="http://tempuri.org/">
      <GetFrequencyListResult>
        <Frequency>
          <frequencyid>int</frequencyid>
          <frequencyname>string</frequencyname>
          <Error>string</Error>
        </Frequency>
        <Frequency>
          <frequencyid>int</frequencyid>
          <frequencyname>string</frequencyname>
          <Error>string</Error>
        </Frequency>
      </GetFrequencyListResult>
    </GetFrequencyListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

Request

POST /towercoverage.asmx HTTP/1.1
Host: api.towercoverage.com
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>
    <GetFrequencyList 
xmlns="http://tempuri.org/">
      <Account>string</Account>
      <key>string</key>
    </GetFrequencyList>
  </soap12:Body>
</soap12:Envelope>

Response

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>
    <GetFrequencyListResponse 
xmlns="http://tempuri.org/">
      <GetFrequencyListResult>
        <Frequency>
          <frequencyid>int</frequencyid>
          <frequencyname>string</frequencyname>
          <Error>string</Error>
        </Frequency>
        <Frequency>
          <frequencyid>int</frequencyid>
          <frequencyname>string</frequencyname>
          <Error>string</Error>
        </Frequency>
      </GetFrequencyListResult>
    </GetFrequencyListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP Get

Request

GET /towercoverage.asmx/GetFrequencyList?
Account=string
&key=string 
HTTP/1.1
Host: api.towercoverage.com

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFrequency 
xmlns="http://tempuri.org/">
  <Frequency>
    <frequencyid>int</frequencyid>
    <frequencyname>string</frequencyname>
    <Error>string</Error>
  </Frequency>
  <Frequency>
    <frequencyid>int</frequencyid>
    <frequencyname>string</frequencyname>
    <Error>string</Error>
  </Frequency>
</ArrayOfFrequency>

HTTP Post

Request

POST /towercoverage.asmx/GetFrequencyList HTTP/1.1
Host: api.towercoverage.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Account=string
&key=string

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFrequency 
xmlns="http://tempuri.org/">
  <Frequency>
    <frequencyid>int</frequencyid>
    <frequencyname>string</frequencyname>
    <Error>string</Error>
  </Frequency>
  <Frequency>
    <frequencyid>int</frequencyid>
    <frequencyname>string</frequencyname>
    <Error>string</Error>
  </Frequency>
</ArrayOfFrequency>