Add / Edit Link Path API

Purpose

The Link Path API has several ways to utilize it. You can use this API to get Path Analysis results between 2 location, Create a New Link in your TowerCoverage.com Account or Update an already existing Link.

Fields

Account / API Key

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

Link ID

The Link ID field is not a required field unless you are wanting to update an existing Link on your account. The Link ID can be located in the URL when you open any individual Link. If you provide a valid Link ID, the only other fields required are Account ID and Key.

Link Name

The Link name field is required and can contain text, numbers dashes and underscore but cannot have return characters or special characters.
Tower Site 1 / Site 2 ID=== This field is not required but if you do not provide a Site ID, one will be created using the Latitude, Longitude, Link Name and Antenna Height.

Latitude / Longitude

These fields are in decimal degrees. If you are in the northern hemisphere, the value will be positive and negative if you are located in the southern hemisphere for the Latitude. The Longitude will be positive value if you are in the eastern hemisphere and negative for the western hemisphere. You do not have to enter these values if you use the Site ID from your tower location.

Site 1 / Site 2 Antenna Height

The Antenna Height is a required field and must be entered in meters as a whole number value.

Rx / Tx Line Loss

This field can be decimal values. For most situations, 0.5 is enough line loss unless your equipment is installed with significant amount of cable between the radio and the antenna. If this is the case, you will need to use the specifications of the cable to determine how much loss you have on your cable.

Antenna Gain

The antenna gain field is a required. Values must be whole numbers only with no text added. Although the Gain is listed in the antenna pattern, you will still need to input the appropriate gain of the antenna that you are using.

Frequency

The Frequency setting values are obtained by using the Get Frequency List and is required for the request. These values change periodically due to more frequencies being added to the available list. The Exact Center Frequency is not required but can be added as a whole number value and will allow you to use the Frequency Coordination feature on the Multi Maps of your account.

Tx Power/Rx Power

For the Tx Power Setting of your coverage, you will need to use whole number values in dBm. If your radio settings are in Watts or Milli-watts, you will need to convert them before inputting them to prevent inaccuracies in your coverage.

Rx Threshold

This is the minimum Rx value that you wish to show on your coverage map and is whole number only value. For WISP operations, we recommend this to be within a few dB of your company’s minimum installation requirements. This will limit the coverage map to only show locations at this value or above. Any location that would get less that this value will not show on your coverage map (even as little as 0.1 dBm less). Our standard recommendation is a -65, but what you enter in this field is based on what values your company’s policies will allow installations. A higher Rx Threshold will reduce your coverage area and will not include areas that lower signal is available at with reduced signal margins. Example: If your company’s standard is that no customer will be installed below -70. Then -70 is your Rx Threshold value. You will need to assume that there is some signal margin in there as well. If your radio’s manufacturer Rx Sensitivity is -78, setting a -70 in this value would allow for an 8db margin.

Use Land Cover / Use Two Rays / Save Link

All three of these fields have a valid value of 1 for yes or 0 for no.

Use Land Cover
This tells the site whether or not to take you Land Cover settings into account in the calculations. See also Land Cover for more information.

Use Two Rays
Two rays are used for multi-path calculations. Most WISP use radios that cannot do multi-path reflections so by default this option is turned off. If your radio system can use multi-path reflections then you may want to turn this value on.

Save Link in Database
This If you want to save the current link in your TowerCoverage.com account, enter a 1 in this field. If you do not wish to save the Link you can enter 0 or leave this value blank. This will not update Tower Sites values of an existing Site ID but if you did not use Site ID's currently in your account, it will create new Sites in 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/LinkPathAPI"

<?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>
    <LinkPathAPI 
xmlns="http://tempuri.org/">
      <Account>string</Account>
        <LinkName>string</LinkName>
        <Linkid>string</Linkid>
      <Site1id>string</Site1id>
      <Site1Latitude>string</Site1Latitude>
      <Site1Longitude>string</Site1Longitude>
      <Site1AntennaHeight>string</Site1AntennaHeight>
      <Site2id>string</Site2id>
      <Site2Latitude>string</Site2Latitude>
      <Site2Longitude>string</Site2Longitude>
      <Site2AntennaHeight>string</Site2AntennaHeight>
      <Frequencyid>string</Frequencyid>
      <TXPower>string</TXPower>
      <TxAntennaGain>string</TxAntennaGain>
      <TxLineLoss>string</TxLineLoss>
      <RxAntennaGain>string</RxAntennaGain>
      <RxLineLoss>string</RxLineLoss>
      <RxThreshold>string</RxThreshold>
      <Reliability>string</Reliability>
      <UseLandCover>string</UseLandCover>
      <UseTwoRays>string</UseTwoRays>
      <Savelinkindatabase>string</Savelinkindatabase>
      <key>string</key>
    </LinkPathAPI>
  </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>
    <LinkPathAPIResponse 
xmlns="http://tempuri.org/">
      <LinkPathAPIResult>
        <Leftsite_ID>string</Leftsite_ID>
        <Leftsite_Latitude>string</Leftsite_Latitude>
        <Leftsite_Longitude>string</Leftsite_Longitude>
        <Leftsite_groundelevation>string</Leftsite_groundelevation>
        <Leftsite_Antennaheight>string</Leftsite_Antennaheight>
        <Leftsite_linkazimuth>string</Leftsite_linkazimuth>
        <Leftsite_linktilt>string</Leftsite_linktilt>
        <leftside_antennagain>string</leftside_antennagain>
        <Rightsite_ID>string</Rightsite_ID>
        <Rightsite_Latitude>string</Rightsite_Latitude>
        <Rightsite_Longitude>string</Rightsite_Longitude>
        <Rightsite_groundelevation>string</Rightsite_groundelevation>
        <Rightsite_Antennaheight>string</Rightsite_Antennaheight>
        <Rightsite_linkazimuth>string</Rightsite_linkazimuth>
        <Rightsite_linktilt>string</Rightsite_linktilt>
        <Rightsite_antennagain>string</Rightsite_antennagain>
        <Rxsensitivity>string</Rxsensitivity>
        <Signalmargin>string</Signalmargin>
        <SignalindBm>string</SignalindBm>
        <Servicequality>string</Servicequality>
        <Distance>string</Distance>
        <Minimumantennaheight>string</Minimumantennaheight>
        <mapdetails>string</mapdetails>
        <Error>string</Error>
      </LinkPathAPIResult>
    </LinkPathAPIResponse>
  </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>
    <LinkPathAPI 
xmlns="http://tempuri.org/">
      <Account>string</Account>
      <LinkName>string</LinkName>
        <Linkid>string</Linkid>
      <Site1id>string</Site1id>
      <Site1Latitude>string</Site1Latitude>
      <Site1Longitude>string</Site1Longitude>
      <Site1AntennaHeight>string</Site1AntennaHeight>
      <Site2id>string</Site2id>
      <Site2Latitude>string</Site2Latitude>
      <Site2Longitude>string</Site2Longitude>
      <Site2AntennaHeight>string</Site2AntennaHeight>
      <Frequencyid>string</Frequencyid>
      <TXPower>string</TXPower>
      <TxAntennaGain>string</TxAntennaGain>
      <TxLineLoss>string</TxLineLoss>
      <RxAntennaGain>string</RxAntennaGain>
      <RxLineLoss>string</RxLineLoss>
      <RxThreshold>string</RxThreshold>
      <Reliability>string</Reliability>
      <UseLandCover>string</UseLandCover>
      <UseTwoRays>string</UseTwoRays>
      <Savelinkindatabase>string</Savelinkindatabase>
      <key>string</key>
    </LinkPathAPI>
  </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>
    <LinkPathAPIResponse 
xmlns="http://tempuri.org/">
      <LinkPathAPIResult>
        <Leftsite_ID>string</Leftsite_ID>
        <Leftsite_Latitude>string</Leftsite_Latitude>
        <Leftsite_Longitude>string</Leftsite_Longitude>
        <Leftsite_groundelevation>string</Leftsite_groundelevation>
        <Leftsite_Antennaheight>string</Leftsite_Antennaheight>
        <Leftsite_linkazimuth>string</Leftsite_linkazimuth>
        <Leftsite_linktilt>string</Leftsite_linktilt>
        <leftside_antennagain>string</leftside_antennagain>
        <Rightsite_ID>string</Rightsite_ID>
        <Rightsite_Latitude>string</Rightsite_Latitude>
        <Rightsite_Longitude>string</Rightsite_Longitude>
        <Rightsite_groundelevation>string</Rightsite_groundelevation>
        <Rightsite_Antennaheight>string</Rightsite_Antennaheight>
        <Rightsite_linkazimuth>string</Rightsite_linkazimuth>
        <Rightsite_linktilt>string</Rightsite_linktilt>
        <Rightsite_antennagain>string</Rightsite_antennagain>
        <Rxsensitivity>string</Rxsensitivity>
        <Signalmargin>string</Signalmargin>
        <SignalindBm>string</SignalindBm>
        <Servicequality>string</Servicequality>
        <Distance>string</Distance>
        <Minimumantennaheight>string</Minimumantennaheight>
        <mapdetails>string</mapdetails>
        <Error>string</Error>
      </LinkPathAPIResult>
    </LinkPathAPIResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP Get

Request

GET /towercoverage.asmx/LinkPathAPI?

       Account=string&
       LinkName=string&
    Linkid=string&
       Site1id=string&
       Site1Latitude=string&
       Site1Longitude=string&
       Site1AntennaHeight=string&
       Site2id=string&
       Site2Latitude=string&
       Site2Longitude=string&
       Site2AntennaHeight=string&
       Frequencyid=string&
       TXPower=string&
       TxAntennaGain=string&
       TxLineLoss=string&
       RxAntennaGain=string&
       RxLineLoss=string&
       RxThreshold=string&
       Reliability=string&
       UseLandCover=string&
       UseTwoRays=string&
       Savelinkindatabase=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"?>
<LinkPathResult 
xmlns="http://tempuri.org/">
  <Leftsite_ID>string</Leftsite_ID>
  <Leftsite_Latitude>string</Leftsite_Latitude>
  <Leftsite_Longitude>string</Leftsite_Longitude>
  <Leftsite_groundelevation>string</Leftsite_groundelevation>
  <Leftsite_Antennaheight>string</Leftsite_Antennaheight>
  <Leftsite_linkazimuth>string</Leftsite_linkazimuth>
  <Leftsite_linktilt>string</Leftsite_linktilt>
  <leftside_antennagain>string</leftside_antennagain>
  <Rightsite_ID>string</Rightsite_ID>
  <Rightsite_Latitude>string</Rightsite_Latitude>
  <Rightsite_Longitude>string</Rightsite_Longitude>
  <Rightsite_groundelevation>string</Rightsite_groundelevation>
  <Rightsite_Antennaheight>string</Rightsite_Antennaheight>
  <Rightsite_linkazimuth>string</Rightsite_linkazimuth>
  <Rightsite_linktilt>string</Rightsite_linktilt>
  <Rightsite_antennagain>string</Rightsite_antennagain>
  <Rxsensitivity>string</Rxsensitivity>
  <Signalmargin>string</Signalmargin>
  <SignalindBm>string</SignalindBm>
  <Servicequality>string</Servicequality>
  <Distance>string</Distance>
  <Minimumantennaheight>string</Minimumantennaheight>
  <mapdetails>string</mapdetails>
  <Error>string</Error>
</LinkPathResult>

HTTP Post

Request

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

Account=string&
LinkName=string&
Linkid=string&
Site1id=string&
Site1Latitude=string&
Site1Longitude=string&
Site1AntennaHeight=string&
Site2id=string&
Site2Latitude=string&
Site2Longitude=string&
Site2AntennaHeight=string&
Frequencyid=string&
TXPower=string&
TxAntennaGain=string&
TxLineLoss=string&
RxAntennaGain=string&
RxLineLoss=string&
RxThreshold=string&
Reliability=string&
UseLandCover=string&
UseTwoRays=string&
Savelinkindatabase=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"?>
<LinkPathResult 
xmlns="http://tempuri.org/">
  <Leftsite_ID>string</Leftsite_ID>
  <Leftsite_Latitude>string</Leftsite_Latitude>
  <Leftsite_Longitude>string</Leftsite_Longitude>
  <Leftsite_groundelevation>string</Leftsite_groundelevation>
  <Leftsite_Antennaheight>string</Leftsite_Antennaheight>
  <Leftsite_linkazimuth>string</Leftsite_linkazimuth>
  <Leftsite_linktilt>string</Leftsite_linktilt>
  <leftside_antennagain>string</leftside_antennagain>
  <Rightsite_ID>string</Rightsite_ID>
  <Rightsite_Latitude>string</Rightsite_Latitude>
  <Rightsite_Longitude>string</Rightsite_Longitude>
  <Rightsite_groundelevation>string</Rightsite_groundelevation>
  <Rightsite_Antennaheight>string</Rightsite_Antennaheight>
  <Rightsite_linkazimuth>string</Rightsite_linkazimuth>
  <Rightsite_linktilt>string</Rightsite_linktilt>
  <Rightsite_antennagain>string</Rightsite_antennagain>
  <Rxsensitivity>string</Rxsensitivity>
  <Signalmargin>string</Signalmargin>
  <SignalindBm>string</SignalindBm>
  <Servicequality>string</Servicequality>
  <Distance>string</Distance>
  <Minimumantennaheight>string</Minimumantennaheight>
  <mapdetails>string</mapdetails>
  <Error>string</Error>
</LinkPathResult>