< back

Add / Edit MultiCoverage API

Purpose

The MultiCoverage API allows you to create or edit MultiCoverages using the API. If you provide a MultiCoverage ID, it will only change the values of the existing MultiCoverage.

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.

mapId:

The mapId value is a string. It is optional if creating a new map but required if you want to update an existing map.

mapName:

The mapName value is a string. It is optional if creating a new map but required if you want to update an existing map.

coverageIds:

This parameter is a string that contains a list of Coverage IDs separated by a comma. It is only Required if it is a new map with no fiber coverage IDs.

fiberCovIds:

This parameter is a string that contains a list of Fiber Coverage IDs separated by a comma. It is only Required if it is a new map with no coverage IDs.

displayPins:

The displayPins value is optional. This value displays pins to represent the tower placement on a MultiCoverage. Valid values include “true” or “false” or “1” or “0”. By default the value will be set to false.

eusDataCollection:

The eusDataCollection value is optional. Activating this value turns on the data collection form inside the Iframe. Valid values include “true” or “false” or “1” or “0”. By default the value will be set to false.

displayFiberOnIframe:

The displayFiberOnIframe value is optional. Activating this value allows fiber polygons to display in the MultiCoverage. Valid values include “true” or “false” or “1” or “0”. By default the value will be set to false.

publicMap:

The publicMap value is optional. Activating this value will set the map to display publicly in the public maps section of TowerCoverage.com. Valid values include “true” or “false” or “1” or “0”. By default the value will be set to false.

zoomLevel:

The zoomLevel value is optional. Making adjustments to this value changes the Zoom level on the MultiCoverage. The Value is numerical and by default the value is set to 10.

centerLatitude:

Center Latitude is not a required field. It is used to help center the map but if a value is not provided it will default to the closest approximation it can find with the data provided.

centerLongitude:

Center Longitude is not a required field. It is used to help center the map but if a value is not provided it will default to the closest approximation it can find with the data provided.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

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

<?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>
    <MultiCoverageAPI xmlns="http://tempuri.org/">
      <accountId>string</accountId>
      <mapId>string</mapId>
      <mapName>string</mapName>
      <coverageIds>string</coverageIds>
      <fiberCovIds>string</fiberCovIds>
      <displayPins>string</displayPins>
      <eusDataCollection>string</eusDataCollection>
      <displayFiberOnIframe>string</displayFiberOnIframe>
      <publicMap>string</publicMap>
      <zoomLevel>string</zoomLevel>
      <centerLatitude>string</centerLatitude>
      <centerLongitude>string</centerLongitude>
      <key>string</key>
    </MultiCoverageAPI>
  </soap:Body>
</soap:Envelope>
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>
    <MultiCoverageAPIResponse xmlns="http://tempuri.org/">
      <MultiCoverageAPIResult>string</MultiCoverageAPIResult>
    </MultiCoverageAPIResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

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>
    <MultiCoverageAPI xmlns="http://tempuri.org/">
      <accountId>string</accountId>
      <mapId>string</mapId>
      <mapName>string</mapName>
      <coverageIds>string</coverageIds>
      <fiberCovIds>string</fiberCovIds>
      <displayPins>string</displayPins>
      <eusDataCollection>string</eusDataCollection>
      <displayFiberOnIframe>string</displayFiberOnIframe>
      <publicMap>string</publicMap>
      <zoomLevel>string</zoomLevel>
      <centerLatitude>string</centerLatitude>
      <centerLongitude>string</centerLongitude>
      <key>string</key>
    </MultiCoverageAPI>
  </soap12:Body>
</soap12:Envelope>
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>
    <MultiCoverageAPIResponse xmlns="http://tempuri.org/">
      <MultiCoverageAPIResult>string</MultiCoverageAPIResult>
    </MultiCoverageAPIResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /towercoverage.asmx/MultiCoverageAPI?accountId=string&mapId=string&mapName=string&coverageIds=string&fiberCovIds=string&displayPins=string&eusDataCollection=string&displayFiberOnIframe=string&publicMap=string&zoomLevel=string&centerLatitude=string&centerLongitude=string&key=string HTTP/1.1
Host: api.towercoverage.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

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

accountId=string&mapId=string&mapName=string&coverageIds=string&fiberCovIds=string&displayPins=string&eusDataCollection=string&displayFiberOnIframe=string&publicMap=string&zoomLevel=string&centerLatitude=string&centerLongitude=string&key=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>