Actions

Difference between revisions of "API"

From The RadioReference Wiki

 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The RadioReference.com Application Programming Interface provides a set of services for Webmasters and Application Developers to integrate data from radioreference.com into their own products.  There are two core components of the RadioReference.com API:
+
RadioReference.com provides a set of APIs for Webmasters and Application Developers to integrate data from radioreference.com into their own products.  There are three different APIs currently available:
  
* Javascript Remote Render Service
+
* SOAP Based Web service for RadioReference Database Data
* REST Based XML Web service
+
* Javascript Remote Render Service for RadioReference Database Data
 +
 
 +
<br />
 +
= The RadioReference SOAP based XML Web service =
 +
 
 +
Application developers have the opportunity to provide users complete access to RadioReference.com data through their own applications.  From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications.
 +
 
 +
The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
 +
 
 +
* http://api.radioreference.com/soap2/?wsdl&v=latest
 +
 
 +
Documentation and version information can be found here:
 +
 
 +
* '''[[RadioReference.com_Web_Service3.1|SOAP Web Service Documentation]]'''
 +
 
 +
Application support and further details can be found at:
 +
 
 +
[[RadioReference.com_Web_Service]].
 +
 
 +
=== Developer Support ===
 +
 
 +
* [http://tech.groups.yahoo.com/group/rr_web_service/ RadioReference API Mailing List]
 +
 
 +
The above mailing list has been created for developers who need support and have questions about how to use the Web service.  In addition, news and announcements related to changes and updates to the Web service will be communicated here.
 +
 
 +
Developers of software applications that use the Web service are strongly encouraged to join.
  
 
= The RadioReference Javascript Remote Render Display Service =
 
= The RadioReference Javascript Remote Render Display Service =
Line 25: Line 50:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
  
[[Image:Scid_api_1.gif|250px|thumb|right|Subcategory Additional Details]]
+
* DOMAIN_KEY = Your uniquely assigned and active domain key
[[Image:Scid_api_2.gif|250px|thumb|right|Subcategory Unique ID (SUBCAT_ID)]]
+
* SUBCAT_ID = The unique radioreference.com subcategory ID.  This can be found by clicking the subcategory additional details icon for a subcategory.  See below:
  
* DOMAIN_KEY = Your uniquely assigned and active domain key
+
[[Image:Scid_api_1.gif|250px|Subcategory Additional Details]]
* SUBCAT_ID = The unique radioreference.com subcategory ID.  This can be found by clicking the subcategory additional details icon for a subcategory.
+
[[Image:Scid_api_2.gif|250px|Subcategory Unique ID (SUBCAT_ID)]]
  
 
For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:
 
For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&scid=195">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=12345678&scid=195">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 53: Line 80:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
  
[[Image:Sid_api_1.gif|250px|thumb|right|Trunked System SID]]
+
* DOMAIN_KEY = Your uniquely assigned and active domain key
 +
* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.  See below:
  
* DOMAIN_KEY = Your uniquely assigned and active domain key
+
[[Image:Sid_api_1.gif|250px|Trunked System SID]]
* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.
 
  
 
For example, to display the Bexar County / San Antonio EDACS system's general information, you would include the following code on your page:
 
For example, to display the Bexar County / San Antonio EDACS system's general information, you would include the following code on your page:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sid=1434">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=12345678&sid=1434">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 73: Line 102:
 
The following would be displayed on the Web page where the code was inserted:
 
The following would be displayed on the Web page where the code was inserted:
  
[[Image:Sid_api_result.gif|border|400px]]
+
[[Image:Sid_api_result.gif|border|250px]]
  
 
=== Talkgroup Category ===
 
=== Talkgroup Category ===
Line 80: Line 109:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
+
<script language="JavaScript"  
 +
src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
  
[[Image:TgCid_api_1.gif|250px|thumb|right|Talkgroup Category Additional Details]]
+
* DOMAIN_KEY = Your uniquely assigned and active domain key
[[Image:TgCid_api_2.gif|250px|thumb|right|Talkgroup Category Unique ID (TGCAT_ID)]]
+
* TGCAT_ID = The unique radioreference.com talkgroup category ID.  This can be found by clicking the talkgroup category additional details icon.  See below:
  
* DOMAIN_KEY = Your uniquely assigned and active domain key
+
 
* TGCAT_ID = The unique radioreference.com talkgroup category ID.  This can be found by clicking the talkgroup category additional details icon.
+
[[Image:TgCid_api_1.gif|250px|Talkgroup Category Additional Details]]
 +
[[Image:TgCid_api_2.gif|250px|Talkgroup Category Unique ID (TGCAT_ID)]]
  
 
For example, to display the City of Arlington's Fire Department Talkgroups from the Arlington Trunked System, you would add the following code:
 
For example, to display the City of Arlington's Fire Department Talkgroups from the Arlington Trunked System, you would add the following code:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
+
<script language="JavaScript"  
 +
src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 108: Line 140:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
 
[[Image:Sidalltg_api_1.gif|250px|thumb|right|Trunked System SID]]
 
  
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.
 
* SID = The unique radioreference.com trunked system system identifier.  This can be found by viewing the URL for the trunked system.
  
For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code:
+
[[Image:Sidalltg_api_1.gif|300px|Trunked System SID]]
 +
 
 +
For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code to your page:
 +
 
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
+
<script language="JavaScript"  
 +
src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 135: Line 170:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
  
[[Image:Site_api_1.gif|250px|thumb|right|Site Additional Details Link]]
+
* DOMAIN_KEY = Your uniquely assigned and active domain key
[[Image:Site_api_2.gif|225px|thumb|right|Site Unique ID (SITE_ID)]]
+
* SITE_ID = The unique radioreference.com siteId.  This can be found by clicking the site description link for a trunked system site. See below:
  
* DOMAIN_KEY = Your uniquely assigned and active domain key
+
[[Image:Site_api_1.gif|250px|Site Additional Details Link]]
* SITE_ID = The unique radioreference.com siteId.  This can be found by clicking the site description link for a trunked system site.
+
[[Image:Site_api_2.gif|225px|Site Unique ID (SITE_ID)]]
  
 
For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:
 
For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
Line 160: Line 197:
 
=== All Trunked System Sites ===
 
=== All Trunked System Sites ===
  
You can display a all trunked system sites with frequencies on a Web page by adding the following code to the page:
+
You can display all trunked system sites with frequencies on a Web page by adding the following code to the page:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
 
[[Image:Site_api_1.gif|250px|thumb|right|Site Additional Details Link]]
 
[[Image:Site_api_2.gif|225px|thumb|right|Site Unique ID (SITE_ID)]]
 
  
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
 
* DOMAIN_KEY = Your uniquely assigned and active domain key
Line 177: Line 212:
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
<script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sites=1434">
+
<script language="JavaScript"
 +
src="http://api.radioreference.com/js/?key=12345678&sites=1434">
 
</script>
 
</script>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
  
= The RadioReference SOAP based XML Web service =
+
=== Customizing the Width of Tables ===
 
 
The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
 
 
 
http://api.radioreference.com/soap/?wsdl
 
  
Further details can be found at:
+
Adding the following to any method query will allow you to customize the width of the table(s) returned by the method (does not apply to audio feed method)
  
[[RadioReference.com_Web_Service]].
+
&width=100%
  
= The RadioReference REST based XML Web service =
+
or
  
The radioreference.com REST based XML Web service is currently documented here:  [[RadioReference.com_Web_Service]].
+
&width=500px
  
[[Category:FAQ]]
+
[[Category:Database FAQ]]

Latest revision as of 09:57, 8 March 2017

RadioReference.com provides a set of APIs for Webmasters and Application Developers to integrate data from radioreference.com into their own products. There are three different APIs currently available:

  • SOAP Based Web service for RadioReference Database Data
  • Javascript Remote Render Service for RadioReference Database Data


The RadioReference SOAP based XML Web service

Application developers have the opportunity to provide users complete access to RadioReference.com data through their own applications. From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications.

The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:

Documentation and version information can be found here:

Application support and further details can be found at:

RadioReference.com_Web_Service.

Developer Support

The above mailing list has been created for developers who need support and have questions about how to use the Web service. In addition, news and announcements related to changes and updates to the Web service will be communicated here.

Developers of software applications that use the Web service are strongly encouraged to join.

The RadioReference Javascript Remote Render Display Service

The RadioReference Javascript remote render service allows webmaster and web page developers to integrate data from the radioreference.com database into their own Web pages.

Steps for using the Javascript remote render service

1. Apply for a domainKey at the following page on your account settings page:

2. Wait for your domainKey to be approved by the administration staff. You will receive an email to your email address on record when approved.

3. Add the necessary javascript code snippet and domainKey to your page for the data you want to remotely render.

Data available for remote rendering

Frequency Subcategory

You can display a frequency subcategory on a Web page by adding the following code to the page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • SUBCAT_ID = The unique radioreference.com subcategory ID. This can be found by clicking the subcategory additional details icon for a subcategory. See below:

Subcategory Additional Details Subcategory Unique ID (SUBCAT_ID)

For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=12345678&scid=195">
</script>

The following would be displayed on the Web page where the code was inserted:

Scid api result.gif

Trunked Radio System Information

You can display a trunking system's general information on a Web page by adding the following code to the page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system. See below:

Trunked System SID

For example, to display the Bexar County / San Antonio EDACS system's general information, you would include the following code on your page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=12345678&sid=1434">
</script>

The following would be displayed on the Web page where the code was inserted:

Sid api result.gif

Talkgroup Category

You can display a talkgroup category's talkgroups on a Web page by adding the following code to the page:


<script language="JavaScript" 
 src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • TGCAT_ID = The unique radioreference.com talkgroup category ID. This can be found by clicking the talkgroup category additional details icon. See below:


Talkgroup Category Additional Details Talkgroup Category Unique ID (TGCAT_ID)

For example, to display the City of Arlington's Fire Department Talkgroups from the Arlington Trunked System, you would add the following code:


<script language="JavaScript" 
 src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
</script>

The following would be displayed on the Web page where the code was inserted:

TgCid api result.gif

Trunked System Complete Talkgroup List

You can display all talkgroups for a trunking system on a Web page by adding the following code to the page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system.

Trunked System SID

For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code to your page:


<script language="JavaScript" 
 src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
</script>

The following would be displayed on the Web page where the code was inserted:

Sidalltg api result.gif

Trunked System Site with Frequencies

You can display a individual trunked system site with frequencies on a Web page by adding the following code to the page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • SITE_ID = The unique radioreference.com siteId. This can be found by clicking the site description link for a trunked system site. See below:

Site Additional Details Link Site Unique ID (SITE_ID)

For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
</script>

The following would be displayed on the Web page where the code was inserted:

Site api result.gif

All Trunked System Sites

You can display all trunked system sites with frequencies on a Web page by adding the following code to the page:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
</script>

  • DOMAIN_KEY = Your uniquely assigned and active domain key
  • SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system.

For example, to display all trunked system sites for the San Antonio TX Public Safety Trunking System, the following code would be used:


<script language="JavaScript"
 src="http://api.radioreference.com/js/?key=12345678&sites=1434">
</script>

Customizing the Width of Tables

Adding the following to any method query will allow you to customize the width of the table(s) returned by the method (does not apply to audio feed method)

&width=100%

or

&width=500px