73 lines
2.1 KiB
Plaintext
73 lines
2.1 KiB
Plaintext
|
<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">
|
||
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<channel>
|
||
|
|
<id type="integer">4</id>
|
||
|
|
<name>My New Channel</name>
|
||
|
|
<description nil="true" />
|
||
|
|
<metadata nil="true" />
|
||
|
|
<latitude type="decimal" nil="true" />
|
||
|
|
<longitude type="decimal" nil="true" />
|
||
|
|
<created-at type="dateTime">2014-03-25T20:17:44-04:00</created-at>
|
||
|
|
<elevation nil="true" />
|
||
|
|
<last-entry-id type="integer" nil="true" />
|
||
|
|
<ranking type="integer">15</ranking>
|
||
|
|
<username>hans</username>
|
||
|
|
<tags type="array" />
|
||
|
|
</channel>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|