101 lines
3.5 KiB
Plaintext
101 lines
3.5 KiB
Plaintext
<div>
|
|
<%= render 'response' %>
|
|
<h2 id="update_feed">Update Channel Feed</h2>
|
|
</div>
|
|
|
|
<br>
|
|
To update a Channel feed, send an HTTP GET or POST to<br>
|
|
<code><%= @ssl_api_domain %>update<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) - Write API Key for this specific Channel (required). The Write API Key can optionally be sent via a <%= HTTP_HEADER_API_KEY_NAME %> HTTP header.</li>
|
|
<li><b>field1</b> (string) - Field 1 data (optional)</li>
|
|
<li><b>field2</b> (string) - Field 2 data (optional)</li>
|
|
<li><b>field3</b> (string) - Field 3 data (optional)</li>
|
|
<li><b>field4</b> (string) - Field 4 data (optional)</li>
|
|
<li><b>field5</b> (string) - Field 5 data (optional)</li>
|
|
<li><b>field6</b> (string) - Field 6 data (optional)</li>
|
|
<li><b>field7</b> (string) - Field 7 data (optional)</li>
|
|
<li><b>field8</b> (string) - Field 8 data (optional)</li>
|
|
<li><b>lat</b> (decimal) - Latitude in degrees (optional)</li>
|
|
<li><b>long</b> (decimal) - Longitude in degrees (optional)</li>
|
|
<li><b>elevation</b> (integer) - Elevation in meters (optional)</li>
|
|
<li><b>status</b> (string) - Status update message (optional)</li>
|
|
<li><b>twitter</b> (string) - Twitter username linked to <a href="/docs/thingtweet">ThingTweet</a> (optional)</li>
|
|
<li><b>tweet</b> (string) - Twitter status update; see <a href="/docs/thingtweet#update">updating ThingTweet</a> for more info (optional)</li>
|
|
<li><b>created_at</b> (datetime) - Date when this feed entry was created, in <a href="http://en.wikipedia.org/wiki/ISO_8601" target=_blank">ISO 8601</a> format, for example: <code>2014-12-31 23:59:59</code> . Time zones can be specified via the <a href="/docs#timezones">timezone</a> parameter (optional)</li>
|
|
</ul>
|
|
|
|
<br>
|
|
Example POST:
|
|
|
|
<pre>
|
|
POST <span class="str"><%= @ssl_api_domain %>update<span class="format format-json">.json</span><span class="format format-xml">.xml</span></span>
|
|
api_key=<span class="customcode"><%= @channel_api_key %></span>
|
|
field1=<span class="customcode">73</span>
|
|
</pre>
|
|
|
|
<br>
|
|
|
|
<div class="format format-block-xl format-text">
|
|
The response will be the entry ID of the update, for example: <code>18</code>
|
|
<br><br>
|
|
If the response is <code>0</code> then the update failed.
|
|
</div>
|
|
|
|
<div class="format format-block-xl format-json">
|
|
The response will be a JSON object of the new feed, for example:
|
|
|
|
<pre class="prettyprint">
|
|
{
|
|
"channel_id": 3,
|
|
"field1": "73",
|
|
"field2": null,
|
|
"field3": null,
|
|
"field4": null,
|
|
"field5": null,
|
|
"field6": null,
|
|
"field7": null,
|
|
"field8": null,
|
|
"created_at": "2014-02-25T14:13:01-05:00",
|
|
"entry_id": 320,
|
|
"status": null,
|
|
"latitude": null,
|
|
"longitude": null,
|
|
"elevation": null,
|
|
"location":null
|
|
}
|
|
</pre>
|
|
|
|
</div>
|
|
|
|
<div class="format format-block-xl format-xml">
|
|
The response will be an XML object of the new feed, for example:
|
|
|
|
<pre class="prettyprint">
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<feed>
|
|
<channel-id type="integer">3</channel-id>
|
|
<field1>73</field1>
|
|
<field2 nil="true"/>
|
|
<field3 nil="true"/>
|
|
<field4 nil="true"/>
|
|
<field5 nil="true"/>
|
|
<field6 nil="true"/>
|
|
<field7 nil="true"/>
|
|
<field8 nil="true"/>
|
|
<created-at type="dateTime">2014-02-25T14:15:42-05:00</created-at>
|
|
<entry-id type="integer">321</entry-id>
|
|
<status nil="true"/>
|
|
<latitude type="decimal" nil="true"/>
|
|
<longitude type="decimal" nil="true"/>
|
|
<elevation nil="true"/>
|
|
<location nil="true"/>
|
|
</feed>
|
|
</pre>
|
|
|
|
</div>
|
|
|