c_meyer/thingspeak
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

add API commands to view a single Channel

Browse Source
This commit is contained in:
Lee Lawlor
2014-08-15 21:56:02 -04:00
parent 83fd941c10
commit 32dac9c9c7
11 changed files with 204 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
app/views/docs/_sidebar.html.erb
View File

@ -20,6 +20,7 @@
<li class="subitem"><a href="#get_field">Get Channel Field Feed</a></li>
<li class="subitem"><a href="#get_status">Get Status Updates</a></li>
<li class="subitem"><a href="#index">List Channels</a></li>
<li class="subitem"><a href="#show">View a Channel</a></li>
<li class="subitem"><a href="#create">Create a Channel</a></li>
<li class="subitem"><a href="#update">Update a Channel</a></li>
<li class="subitem"><a href="#clear">Clear a Channel</a></li>

3
app/views/docs/channels.html.erb
View File

@ -116,6 +116,9 @@
<hr />
<%= render 'docs/channels/index' %>
<hr />
<%= render 'docs/channels/show' %>
<hr />
<%= render 'docs/channels/create' %>

72
app/views/docs/channels/_show.html.erb Normal file
View File

@ -0,0 +1,72 @@
<div>
<%= render 'response' %>
<h2 id="show">View a Channel</h2>
</div>
<br>
To view a specific Channel, send an HTTP GET to
<br>
<code><%= @ssl_api_domain %>channels/<span class="customcode">CHANNEL_ID</span><span class="format format-json">.json</span><span class="format format-xml">.xml</span></code> .
<br><br>
Valid parameters:
<ul>
<li><b>api_key</b> (string) - User's API Key; please note that this is different than a Channel API key, and can be found in <a href="/account">your account details</a>. If this key is provided, the Channel's private details (such as the Channel's API keys) will also be shown. (optional).</li>
</ul>
<br>
Example GET:
<pre>GET <span class="str"><%= @ssl_api_domain %>channels/1417<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span></pre>
<br>
<div class="format format-block-xxxl format-text">
The response will be a webpage that shows the Channel.
</div>
<div class="format format-block-xxxl format-json">
The response will be a JSON object of the Channel, for example:
<pre class="prettyprint">
{
"id": 4,
"name": "My New Channel",
"description": null,
"metadata": null,
"latitude": null,
"longitude": null,
"created_at": "2014-03-25T13:12:50-04:00",
"elevation": null,
"last_entry_id": null,
"ranking": 15,
"username": "hans",
"tags": []
}
</pre>
</div>
<div class="format format-block-xxxl format-xml">
The response will be an XML object of public Channels, for example:
<pre class="prettyprint">
&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;channel>
&lt;id type="integer">4&lt;/id>
&lt;name>My New Channel&lt;/name>
&lt;description nil="true" />
&lt;metadata nil="true" />
&lt;latitude type="decimal" nil="true" />
&lt;longitude type="decimal" nil="true" />
&lt;created-at type="dateTime">2014-03-25T20:17:44-04:00&lt;/created-at>
&lt;elevation nil="true" />
&lt;last-entry-id type="integer" nil="true" />
&lt;ranking type="integer">15&lt;/ranking>
&lt;username>hans&lt;/username>
&lt;tags type="array" />
&lt;/channel>
</pre>
</div>