SPOT Shared Page API and XML Feed Information
Author: Article Reference #:AA-00006 Views:45638 Date Added:2012-10-26 12:00 AM Last Updated:2014-08-06 06:51 AM 3.65 Rating/ 142 Voters
SPOT API Support: api_support@findmespot.com


Current API information:

Be considerate when making API calls, this service is provided free of charge, please do not abuse it. Repeatedly accessing the same feed in very short time periods will result in your IP being blocked or your feed disabled.

If you start receiving a 403 error when you attempt to access your feed it is because you are polling much too quickly and you will need to email api_support@findmespot.com in order to get your feed reinstated.  Please allow as least 2.5 minutes between calls of the same feed and if you are pulling multiple feeds have your application sleep at least 2 seconds between feed requests.



-- The API will only return data from the point where the feed was created, up to a maximum of 7 days. --


The SPOT shared page is built upon an XML data stream that is enabled when a new shared page is created. The glId in the following url is the FEED_ID you will need below. (Please note the glId/FEED_ID in the examples below is non-functional, it is for example purposes only)
http://share.findmespot.com/shared/faces/viewspots.jsp?glId=0XapxKiqW4RCHYhVkaCBpaHT3cNMUcEef
The FEED_ID in the above Shared Page URL is: 0XapxKiqW4RCHYhVkaCBpaHT3cNMUcEef

The default content type returned by the API is JSON.  Some browsers apparently display it as XML even though the API returns it as JSON.  If you want to ensure your content type, append the appropriate switch (.xml or .json).



Available API usage calls:
Default content-type returned is JSON, adding .xml before any further query string parameters will return XML
https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/FEED_ID_HERE/message.xml

Last 50 Messages in XML format:
https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/FEED_ID_HERE/message.xml

Paging in increments of 50 in XML format (Note: No ?start= results in newest 50 by default):
https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/FEED_ID_HERE/message.xml?start=51
https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/FEED_ID_HERE/message.xml?start=101

Last 50 Messages in JSON format (both are the same request):

Latest - This one will show you the latest message for each device on the shared page, and only the latest message:
https://api.findmespot.com/spot-main-web/consumer/rest-api/2.0/public/feed/FEED_ID_HERE/latest.xml


The following message types are available via the current feed:
  • OK
  • TRACK
  • EXTREME-TRACK
  • UNLIMITED-TRACK
  • NEWMOVEMENT
  • HELP
  • HELP-CANCEL
  • CUSTOM
  • POI
  • STOP
The XML returned via an api.findmespot.com feed will look like this:
<?xml version="1.0" encoding="UTF-8"?>
<response>
	<feedMessageResponse>
		<count>10</count>
		<feed>
			<id>03XHH0sPyTiYUsYD2TVJ4q7CzEH89HBhG</id>
			<name>OneAtATime</name>
			<description>OneAtATime</description>
			<status>ACTIVE</status>
			<usage>0</usage>
			<daysRange>7</daysRange>
			<detailedMessageShown>true</detailedMessageShown>
		</feed>
		<totalCount>10</totalCount>
		<activityCount>0</activityCount>
		<messages>
			<message clientUnixTime="0">
				<id>4937065</id>
				<messengerId>0-8356068</messengerId>
				<messengerName>Spot2</messengerName>
				<unixTime>1364909292</unixTime>
				<messageType>HELP-CANCEL</messageType>
				<latitude>-99999.0</latitude>
				<longitude>-99999.0</longitude>
				<modelId>SPOT2</modelId>
				<showCustomMsg>Y</showCustomMsg>
				<dateTime>2013-04-02T06:28:12-0700</dateTime>
				<hidden>0</hidden>
				<messageContent>The help message has been cancelled</messageContent>
			</message>
			<message clientUnixTime="0">
				<id>4937064</id>
				<messengerId>0-8356068</messengerId>
				<messengerName>Spot2</messengerName>
				<unixTime>1364909283</unixTime>
				<messageType>HELP</messageType>
				<latitude>45.42249</latitude>
				<longitude>-111.68832</longitude>
				<modelId>SPOT2</modelId>
				<showCustomMsg>Y</showCustomMsg>
				<dateTime>2013-04-02T06:28:03-0700</dateTime>
				<hidden>0</hidden>
				<messageContent>This is the default HELP message. Please update.</messageContent>
			</message>
			<message clientUnixTime="0">
				<id>4937060</id>
				<messengerId>0-8356068</messengerId>
				<messengerName>Spot2</messengerName>
				<unixTime>1364908774</unixTime>
				<messageType>CUSTOM</messageType>
				<latitude>45.42249</latitude>
				<longitude>-111.68832</longitude>
				<modelId>SPOT2</modelId>
				<showCustomMsg>Y</showCustomMsg>
				<dateTime>2013-04-02T06:19:34-0700</dateTime>
				<hidden>0</hidden>
				<messageContent>This is a custom message</messageContent>
			</message>
			<message clientUnixTime="0">
				<id>4937059</id>
				<messengerId>0-8356068</messengerId>
				<messengerName>Spot2</messengerName>
				<unixTime>1364908765</unixTime>
				<messageType>OK</messageType>
				<latitude>45.42249</latitude>
				<longitude>-111.68832</longitude>
				<modelId>SPOT2</modelId>
				<showCustomMsg>Y</showCustomMsg>
				<dateTime>2013-04-02T06:19:25-0700</dateTime>
				<hidden>0</hidden>
				<messageContent>This is the default SPOT Check-in/OK message. Please update.</messageContent>
			</message>
			<message clientUnixTime="0">
				<id>4937057</id>
				<messengerId>0-8356068</messengerId>
				<messengerName>Spot2</messengerName>
				<unixTime>1364908512</unixTime>
				<messageType>TRACK</messageType>
				<latitude>45.42249</latitude>
				<longitude>-111.68832</longitude>
				<modelId>SPOT2</modelId>
				<showCustomMsg>Y</showCustomMsg>
				<dateTime>2013-04-02T06:15:12-0700</dateTime>
				<hidden>0</hidden>
			</message>
		</messages>
	</feedMessageResponse>
</response>

The XML document will contain 0 or more messages. Only the messengers and message types enabled by the customer will be available in this data stream. In addition, viewing limits are imposed on all shared page links and abuse of this feature may cause the viewing limits to come into effect.
Quick Jump
Go
Subscribe to updates Subscribe to Updates
Email to a frien Email to a Friend
Print Print Article
Info Tell your opinion about this article
Rate