Actions

Difference between revisions of "RR Javascript remote render service"

From The RadioReference Wiki

(Replaced content with "This API has been deprecated and is no longer available Category:Database FAQ")
Tag: Replaced
 
Line 1: Line 1:
The RadioReference Javascript remote render service allows web designers and web page developers to integrate data from the radioreference.com database into their own Web pages. 
+
This API has been deprecated and is no longer available
 
 
=== Steps for using the Javascript remote render service ===
 
 
 
1.  Apply for a domain key at the following page on your account settings page: 
 
 
 
* https://www.radioreference.com/account/api
 
<br />
 
 
 
2.  Wait for your domain key to be approved by the administration staff my key is me
 
 
 
=== 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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:
 
 
 
[[Image:Scid_api_1.gif|250px|Subcategory Additional Details]]
 
[[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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&scid=195">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following would be displayed on the Web page where the code was inserted:
 
 
 
[[Image:Scid_api_result.gif|border|400px]]
 
 
 
==== 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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:
 
 
 
[[Image:Sid_api_1.gif|250px|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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&sid=1434">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following would be displayed on the Web page where the code was inserted:
 
 
 
[[Image:Sid_api_result.gif|border|250px]]
 
 
 
==== Talkgroup Category ====
 
 
 
You can display a talkgroup category's talkgroups on a Web page by adding the following code to the page:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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:
 
 
 
 
 
[[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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&tgCid=2">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following would be displayed on the Web page where the code was inserted:
 
 
 
[[Image:TgCid_api_result.gif|border|400px]]
 
 
 
==== 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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.
 
 
 
[[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>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&sidalltg=5636">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following would be displayed on the Web page where the code was inserted:
 
 
 
[[Image:Sidalltg_api_result.gif|border|400px]]
 
 
 
==== 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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:
 
 
 
[[Image:Site_api_1.gif|250px|Site Additional Details Link]]
 
[[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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&siteId=10500">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
The following would be displayed on the Web page where the code was inserted:
 
 
 
[[Image:Site_api_result.gif|border|500px]]
 
 
 
==== 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
* 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:
 
<pre>
 
<nowiki>
 
<script language="JavaScript"
 
src="https://api.radioreference.com/js/?key=12345678&sites=1434">
 
</script>
 
</nowiki>
 
</pre>
 
 
 
==== 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
 
 
 
  
 
[[Category:Database FAQ]]
 
[[Category:Database FAQ]]

Latest revision as of 16:20, 20 April 2024

This API has been deprecated and is no longer available