PreQual API With Coverage and Signal Projection
Purpose
This version of the PreQual API allows you to check if a given location is serviceable on your Network, along with providing you its associated coverage as well as a projected signal strength for that end point. When a request is made to api.towercoverage.com, the server will check that all values are valid and ensure you have available calls on your account. If calls are available and all values are valid, it will provide a response of "yes" if the location is serviceable and "no" if it is not. It will also return the coverageID, CoverageName, and Signal Strength for each of the 6 best links. Each link will be separated by a ";" If the end point is within a Fiber Coverage it will return the FiberID and FiberName.Fields
MCID
This field is a number value only. Each Multi Map on your account is assigned an ID when it is created. This number will never change until the map is deleted. You can locate the Multi Coverage ID by using the Get Multicoverage List API or by opening the map that you wish to use. The ID can also be found in the URL of the map or in the iframe code on the update tab.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.Address / City / Country / State / Zip Code / Latitude / Longitude
When entering addresses, your state must be spelled out, abbreviations are not allowed. Example: United States.
All Lat/Long values must be entered in decimal degrees with appropriate positive or negative values depending on your location.
Example: 38.16484851, -91.5343546. Is a North American GPS Coordinate.
RxMargin
This field is not required if you would like to use all current coverage settings. Setting a RxMargin value will add or subtract accordingly to the RxThreshold of all included Coverages in the Multi Map you have submitted to. Example: An RxMargin of 10 would change all that are set to -70 to -60. A -10 the result would be -80. Any decimal values will be rounded.
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/EUSPrequalAPI""http://tempuri.org/EUSPrequalAPIPlusCoverageId" <?xml version="1.0"encoding="utf-8" ?>encoding="utf-8"?><soap:envelope<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> <eusprequalapi<soap:Body> <EUSPrequalAPIPlusCoverageId xmlns="http://tempuri.org/"> <multicoverageid>string</multicoverageid> <Account>string</Account> <Address>string</Address> <city>string</city> <Country>string</Country> <State>string</State> <zipcode>string</zipcode> <Latitude>string</Latitude> <Longitude>string</Longitude> <RxMargin>string</RxMargin> <key>string</key> </EUSPrequalAPIPlusCoverageId> </soap:Body><multicoverageid>string</multicoverageid> <account>string</account> <address>string</address> <city>string</city> <country>string</country> <state>string</state> <zipcode>string</zipcode> <latitude>string</latitude> <longitude>string</longitude> <rxmargin>string</rxmargin> <key>string</key> </eusprequalapi> </soap:body> </soap:envelope></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" ?>encoding="utf-8"?><soap:envelope<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> <eusprequalapiresponse<soap:Body> <EUSPrequalAPIPlusCoverageIdResponse xmlns="http://tempuri.org/"> <EUSPrequalAPIPlusCoverageIdResult>string</EUSPrequalAPIPlusCoverageIdResult> </EUSPrequalAPIPlusCoverageIdResponse> </soap:Body><eusprequalapiresult>string</eusprequalapiresult> </eusprequalapiresponse> </soap:body> </soap:envelope></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" ?>encoding="utf-8"?><soap12:envelope<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> <eusprequalapi<soap12:Body> <EUSPrequalAPIPlusCoverageId xmlns="http://tempuri.org/"> <multicoverageid>string</multicoverageid> <Account>string</Account> <Address>string</Address> <city>string</city> <Country>string</Country> <State>string</State> <zipcode>string</zipcode> <Latitude>string</Latitude> <Longitude>string</Longitude> <RxMargin>string</RxMargin> <key>string</key> </EUSPrequalAPIPlusCoverageId> </soap12:Body><multicoverageid>string</multicoverageid> <account>string</account> <address>string</address> <city>string</city> <country>string</country> <state>string</state> <zipcode>string</zipcode> <latitude>string</latitude> <longitude>string</longitude> <rxmargin>string</rxmargin> <key>string</key> </eusprequalapi> </soap12:body> </soap12:envelope></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:Envelopexmlns: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><PreQualResponse<EUSPrequalAPIPlusCoverageIdResponse xmlns="http://tempuri.org/"><PrequalResult>string</PrequalResult><EUSPrequalAPIPlusCoverageIdResult>string</EUSPrequalAPIPlusCoverageIdResult></PreQualResponse></EUSPrequalAPIPlusCoverageIdResponse> </soap12:Body> </soap12:Envelope>
HTTP Get
Request
GET/towercoverage.asmx/EUSPrequalAPI?multicoverageid=string&Account=string&Address=string&city=string&Country=string&State=string&zipcode=string&Latitude=string&Longitude=string&RxMargin=string&key=string/towercoverage.asmx/EUSPrequalAPIPlusCoverageId?multicoverageid=string&Account=string&Address=string&city=string&Country=string&State=string&zipcode=string&Latitude=string&Longitude=string&RxMargin=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"?> <stringxmlns="http://tempuri.org/">string</string>
HTTP Post
Request
POST/towercoverage.asmx/EUSPrequalAPI/towercoverage.asmx/EUSPrequalAPIPlusCoverageId HTTP/1.1 Host: api.towercoverage.com Content-Type: application/x-www-form-urlencoded Content-Length: length multicoverageid=string&Account=string&Address=string&city=string&Country=string&State=string&zipcode=string&Latitude=string&Longitude=string&RxMargin=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" ?>encoding="utf-8"?> <string xmlns="http://tempuri.org/">string</string>