Get Link List API

Purpose

The Get Link List API is used to request the list of current Links that are in TowerCoverage.com.

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

<?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>
    <GetLinkList xmlns="http://tempuri.org/">
      <Account>string</Account>
      <key>string</key>
    </GetLinkList>
  </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>
    <GetLinkListResponse xmlns="http://tempuri.org/">
      <GetLinkListResult>
        <Link>
          <Linkid>int</Linkid>
          <LinkName>string</LinkName>
          <FromSiteID>int</FromSiteID>
          <ToSiteID>int</ToSiteID>
          <FromAntHeight>int</FromAntHeight>
          <ToAntHeight>int</ToAntHeight>
          <FrequencyID>int</FrequencyID>
          <TxPower>int</TxPower>
          <TxLineLoss>string</TxLineLoss>
          <TxAntGain>int</TxAntGain>
          <RxLineLoss>string</RxLineLoss>
          <RxAntGain>int</RxAntGain>
          <RxThreshold>int</RxThreshold>
          <Reliability>int</Reliability>
          <UseLandCover>boolean</UseLandCover>
          <UseTwoRays>boolean</UseTwoRays>
          <LastUpdated>dateTime</LastUpdated>
          <Error>string</Error>
        </Link>
        <Link>
          <Linkid>int</Linkid>
          <LinkName>string</LinkName>
          <FromSiteID>int</FromSiteID>
          <ToSiteID>int</ToSiteID>
          <FromAntHeight>int</FromAntHeight>
          <ToAntHeight>int</ToAntHeight>
          <FrequencyID>int</FrequencyID>
          <TxPower>int</TxPower>
          <TxLineLoss>string</TxLineLoss>
          <TxAntGain>int</TxAntGain>
          <RxLineLoss>string</RxLineLoss>
          <RxAntGain>int</RxAntGain>
          <RxThreshold>int</RxThreshold>
          <Reliability>int</Reliability>
          <UseLandCover>boolean</UseLandCover>
          <UseTwoRays>boolean</UseTwoRays>
          <LastUpdated>dateTime</LastUpdated>
          <Error>string</Error>
        </Link>
      </GetLinkListResult>
    </GetLinkListResponse>
  </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>
    <GetLinkList xmlns="http://tempuri.org/">
      <Account>string</Account>
      <key>string</key>
    </GetLinkList>
  </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>
    <GetLinkListResponse xmlns="http://tempuri.org/">
      <GetLinkListResult>
        <Link>
          <Linkid>int</Linkid>
          <LinkName>string</LinkName>
          <FromSiteID>int</FromSiteID>
          <ToSiteID>int</ToSiteID>
          <FromAntHeight>int</FromAntHeight>
          <ToAntHeight>int</ToAntHeight>
          <FrequencyID>int</FrequencyID>
          <TxPower>int</TxPower>
          <TxLineLoss>string</TxLineLoss>
          <TxAntGain>int</TxAntGain>
          <RxLineLoss>string</RxLineLoss>
          <RxAntGain>int</RxAntGain>
          <RxThreshold>int</RxThreshold>
          <Reliability>int</Reliability>
          <UseLandCover>boolean</UseLandCover>
          <UseTwoRays>boolean</UseTwoRays>
          <LastUpdated>dateTime</LastUpdated>
          <Error>string</Error>
        </Link>
        <Link>
          <Linkid>int</Linkid>
          <LinkName>string</LinkName>
          <FromSiteID>int</FromSiteID>
          <ToSiteID>int</ToSiteID>
          <FromAntHeight>int</FromAntHeight>
          <ToAntHeight>int</ToAntHeight>
          <FrequencyID>int</FrequencyID>
          <TxPower>int</TxPower>
          <TxLineLoss>string</TxLineLoss>
          <TxAntGain>int</TxAntGain>
          <RxLineLoss>string</RxLineLoss>
          <RxAntGain>int</RxAntGain>
          <RxThreshold>int</RxThreshold>
          <Reliability>int</Reliability>
          <UseLandCover>boolean</UseLandCover>
          <UseTwoRays>boolean</UseTwoRays>
          <LastUpdated>dateTime</LastUpdated>
          <Error>string</Error>
        </Link>
      </GetLinkListResult>
    </GetLinkListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP Get

Request

GET /towercoverage.asmx/GetLinkList?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"?>
<ArrayOfLink xmlns="http://tempuri.org/">
  <Link>
    <Linkid>int</Linkid>
    <LinkName>string</LinkName>
    <FromSiteID>int</FromSiteID>
    <ToSiteID>int</ToSiteID>
    <FromAntHeight>int</FromAntHeight>
    <ToAntHeight>int</ToAntHeight>
    <FrequencyID>int</FrequencyID>
    <TxPower>int</TxPower>
    <TxLineLoss>string</TxLineLoss>
    <TxAntGain>int</TxAntGain>
    <RxLineLoss>string</RxLineLoss>
    <RxAntGain>int</RxAntGain>
    <RxThreshold>int</RxThreshold>
    <Reliability>int</Reliability>
    <UseLandCover>boolean</UseLandCover>
    <UseTwoRays>boolean</UseTwoRays>
    <LastUpdated>dateTime</LastUpdated>
    <Error>string</Error>
  </Link>
  <Link>
    <Linkid>int</Linkid>
    <LinkName>string</LinkName>
    <FromSiteID>int</FromSiteID>
    <ToSiteID>int</ToSiteID>
    <FromAntHeight>int</FromAntHeight>
    <ToAntHeight>int</ToAntHeight>
    <FrequencyID>int</FrequencyID>
    <TxPower>int</TxPower>
    <TxLineLoss>string</TxLineLoss>
    <TxAntGain>int</TxAntGain>
    <RxLineLoss>string</RxLineLoss>
    <RxAntGain>int</RxAntGain>
    <RxThreshold>int</RxThreshold>
    <Reliability>int</Reliability>
    <UseLandCover>boolean</UseLandCover>
    <UseTwoRays>boolean</UseTwoRays>
    <LastUpdated>dateTime</LastUpdated>
    <Error>string</Error>
  </Link>
</ArrayOfLink>

HTTP Post

Request

POST /towercoverage.asmx/GetLinkList 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"?>
<ArrayOfLink xmlns="http://tempuri.org/">
  <Link>
    <Linkid>int</Linkid>
    <LinkName>string</LinkName>
    <FromSiteID>int</FromSiteID>
    <ToSiteID>int</ToSiteID>
    <FromAntHeight>int</FromAntHeight>
    <ToAntHeight>int</ToAntHeight>
    <FrequencyID>int</FrequencyID>
    <TxPower>int</TxPower>
    <TxLineLoss>string</TxLineLoss>
    <TxAntGain>int</TxAntGain>
    <RxLineLoss>string</RxLineLoss>
    <RxAntGain>int</RxAntGain>
    <RxThreshold>int</RxThreshold>
    <Reliability>int</Reliability>
    <UseLandCover>boolean</UseLandCover>
    <UseTwoRays>boolean</UseTwoRays>
    <LastUpdated>dateTime</LastUpdated>
    <Error>string</Error>
  </Link>
  <Link>
    <Linkid>int</Linkid>
    <LinkName>string</LinkName>
    <FromSiteID>int</FromSiteID>
    <ToSiteID>int</ToSiteID>
    <FromAntHeight>int</FromAntHeight>
    <ToAntHeight>int</ToAntHeight>
    <FrequencyID>int</FrequencyID>
    <TxPower>int</TxPower>
    <TxLineLoss>string</TxLineLoss>
    <TxAntGain>int</TxAntGain>
    <RxLineLoss>string</RxLineLoss>
    <RxAntGain>int</RxAntGain>
    <RxThreshold>int</RxThreshold>
    <Reliability>int</Reliability>
    <UseLandCover>boolean</UseLandCover>
    <UseTwoRays>boolean</UseTwoRays>
    <LastUpdated>dateTime</LastUpdated>
    <Error>string</Error>
  </Link>
</ArrayOfLink>