Differences

This shows you the differences between two versions of the page.

--- map_suite_gps_tracking_server_device_gateway_overview [2015/09/10 07:40]
admin [Updating Device Commands]
+++ map_suite_gps_tracking_server_device_gateway_overview [2015/09/25 03:11] (current)
admin [Receiving Device Commands]
@@ Line 53: / Line 53: @@
 ''APIKey'' - For this parameter, enter your individual Map Suite GPS Tracking Server API key.  You received your API key when you signed up for your Map Suite GPS Tracking Server Starter Edition account.
-''XMLmessage'' - This parameter represents the XML message that you will be posting to the Device Gateway.  Creating the XML message will be the main task of your custom device listener.  The XML message is made up of several elements that allow it to be flexible and that also provide enough information for the Map Suite GPS Tracking Server web portal to function properly.  You can download a detailed schema of the XML document from a particular URL on your Device Gateway server.  For instance, if your Device Gateway is hosted at <nowiki>https://gateway.thinkgeo.com</nowiki>, you can download the XML schema from <tt><nowiki>https://gateway.thinkgeo.com/LocationMessage.xsd</nowiki></tt>.
+''XMLmessage'' - This parameter represents the XML message that you will be posting to the Device Gateway.  Creating the XML message will be the main task of your custom device listener.  The XML message is made up of several elements that allow it to be flexible and that also provide enough information for the Map Suite GPS Tracking Server web portal to function properly.  You can download a detailed schema of the XML document from a particular URL on your Device Gateway server.  For instance, if your Device Gateway is hosted at <nowiki>https://gateway.thinkgeo.com</nowiki>, you can download the XML schema from //<nowiki>https://gateway.thinkgeo.com/LocationMessage.xsd</nowiki>//.
 Below is a summary of each element included in the XML message document.
@@ Line 59: / Line 59: @@
 ''<LocationMessage>'' - Required top-level element that encapsulates the entire XML message.
-:  ''<DeviceID>'' - Required element that contains the ID of the device that is posting the information.  If your device is using cellular technology, this is typically the IMEI or ESN number.
+　　''<DeviceID>'' - Required element that contains the ID of the device that is posting the information.  If your device is using cellular technology, this is typically the IMEI or ESN number.
-:  ''<UtcDateTime>'' - Required element that contains the UTC time at which the information was received from the device.
+　　''<UtcDateTime>'' - Required element that contains the UTC time at which the information was received from the device.
-:  ''<Longitude>'' - Required element that contains the longitude (X) coordinate of the device's location.
+　　''<Longitude>'' - Required element that contains the longitude (X) coordinate of the device's location.
-:  ''<Latitude>'' - Required element that contains the latitude (Y) coordinate of the device's location.
+　　''<Latitude>'' - Required element that contains the latitude (Y) coordinate of the device's location.
-:  ''<GpsAccuracyInMeters>'' - Required element that represents the accuracy of the location coordinates that the device is reporting.  If you don't know the accuracy of your GPS device, we suggest you put a default value that is greater than 0.  (If you put 0, Map Suite GPS Tracking Server will disregard the location information and not trigger any location-based alerts.)
+　　''<GpsAccuracyInMeters>'' - Required element that represents the accuracy of the location coordinates that the device is reporting.  If you don't know the accuracy of your GPS device, we suggest you put a default value that is greater than 0.  (If you put 0, Map Suite GPS Tracking Server will disregard the location information and not trigger any location-based alerts.)
-:  ''<AltitudeInMeters>'' - Required element that represents the altitude of the location that the device is reporting.  If no altitude is known, put 0.
+　　''<AltitudeInMeters>'' - Required element that represents the altitude of the location that the device is reporting.  If no altitude is known, put 0.
-: ''<SpeedInKph>'' - Required element that represents the current speed (in kilometers per hour) that the device is traveling at.
+　　''<SpeedInKph>'' - Required element that represents the current speed (in kilometers per hour) that the device is traveling at.
-: ''<Idle>'' - Optional element that represents whether the device's status is idling or not. If you don't know or your device doesn't support idling, put 0.
+　　''<Idle>'' - Optional element that represents whether the device's status is idling or not. If you don't know or your device doesn't support idling, put 0.
-: ''<Heading>'' - Required element representing the current heading in degrees (0-360) that the device is reporting.  If no heading is known, put 0.
+　　''<Heading>'' - Required element representing the current heading in degrees (0-360) that the device is reporting.  If no heading is known, put 0.
-: ''<RawDebugMessage>'' - Required element representing the entire raw message from the device before it was parsed.  This information can sometimes be helpful for troubleshooting and debugging device problems.  If no debugging information is needed, you can leave this element blank.
+　　''<RawDebugMessage>'' - Required element representing the entire raw message from the device before it was parsed.  This information can sometimes be helpful for troubleshooting and debugging device problems.  If no debugging information is needed, you can leave this element blank.
-: ''<DeviceAlerts>'' - Optional element that will contain one or many ''<DeviceAlert>'' elements (see below).
+　　''<DeviceAlerts>'' - Optional element that will contain one or many ''<DeviceAlert>'' elements (see below).
-:: ''<DeviceAlert>'' - Optional element that represents a device triggered alert.  One &lt;DeviceAlert&gt; element should be included for each alert that will be triggered.  For example, if you had both an AirBag alert and an OpenDoor alert triggered, there would be two <DeviceAlert> elements, one for each individual alert.
+　　　　''<DeviceAlert>'' - Optional element that represents a device triggered alert.  One &lt;DeviceAlert&gt; element should be included for each alert that will be triggered.  For example, if you had both an AirBag alert and an OpenDoor alert triggered, there would be two <DeviceAlert> elements, one for each individual alert.
-: ''<CustomData>'' - Optional element that will contain one or many child ''<CustomData>'' elements (see below).
+　　''<CustomData>'' - Optional element that will contain one or many child ''<CustomData>'' elements (see below).
-:: ''<CustomData Name="Custom Data Name" MIMEType="Data Type">'' - Optional element that represents any custom data that the device may be providing.  This element also has two attributes called ''Name'' and ''MIMEType''.  The ''Name'' attribute controls the name that you want to give to the CustomData (for instance, "Photo File" or "Engine RPM") while the ''MIMEType'' attribute represents the MIME type of the custom data (for instance, "image/jpeg" or "text/plain").  For reference, here is [[http://www.utoronto.ca/webdocs/HTMLdocs/book/book-3ed/appb/mimetype.html|a list of available MIME types]].
+　　　　''<CustomData Name="Custom Data Name" MIMEType="Data Type">'' - Optional element that represents any custom data that the device may be providing.  This element also has two attributes called ''Name'' and ''MIMEType''.  The ''Name'' attribute controls the name that you want to give to the CustomData (for instance, "Photo File" or "Engine RPM") while the ''MIMEType'' attribute represents the MIME type of the custom data (for instance, "image/jpeg" or "text/plain").  For reference, here is [[http://www.utoronto.ca/webdocs/HTMLdocs/book/book-3ed/appb/mimetype.html|a list of available MIME types]].
 Once you have created a valid XML document, the only thing left to do is populate the ''XMLmessage'' parameter and execute the web method.  Once you do, the new data should be visible in your Map Suite GPS Tracking Server web portal within a few seconds.
@@ Line 103: / Line 103: @@
 ''<DeviceCommandMessages>'' - Top-level element of the XML document that will encapsulate all of the device command messages.
-:  ''<DeviceCommandMessage>'' - Parent element for a device command message.
+　　''<DeviceCommandMessage>'' - Parent element for a device command message.
-::   ''<DeviceCommandMessageID>'' - Unique ID of the device command message.
+　　　　''<DeviceCommandMessageID>'' - Unique ID of the device command message.
-:::    ''<DeviceID>'' - This is a unique identifier for the actual tracking device.  It's typically a phone number or email address, which allows the listener to proactively communicate with the device.
+　　　　　　''<DeviceID>'' - This is a unique identifier for the actual tracking device.  It's typically a phone number or email address, which allows the listener to proactively communicate with the device.
-:::    ''<Parameters>'' - Parent element for all of the device command message's parameters.
+　　　　　　''<Parameters>'' - Parent element for all of the device command message's parameters.
-:::: ''<Parameter Name="Parameter Name">'' - This element contains any parameter information needed for the device command message to be processed by the listener.
+　　　　　　　　''<Parameter Name="Parameter Name">'' - This element contains any parameter information needed for the device command message to be processed by the listener.
 ==== Updating Device Commands ====
-Once you have successfully processed the device command in your device listener, you will want to update its status so that the end user knows whether the command completed successfully or not.  To do this, use the <code>UpdateDeviceCommandStatus</code> method described below.  (If you don't update the status, the Map Suite GPS Tracking Server Device Gateway will automatically expire the device command message after a specified amount of time.)
+Once you have successfully processed the device command in your device listener, you will want to update its status so that the end user knows whether the command completed successfully or not.  To do this, use the ''UpdateDeviceCommandStatus'' method described below.  (If you don't update the status, the Map Suite GPS Tracking Server Device Gateway will automatically expire the device command message after a specified amount of time.)
 <code csharp>

User Tools

Site Tools

Differences

Page Tools