YELLOWBRICK V3 User Manual

RockSTAR XML APIA quick-start, example-led guide to the RockSTAR XML API! ! Version 3.0 - Updated 14th February [email protected]

Configuration ReportsYou can request the last-known configuration for a particular device.To return the last-known configuration for tracker serial 2322:

Requesting ConfigurationTo request the tracker with serial 2322 to transmit a configuration report:https://secure.rock7mobile.com/API2/RequestConfig/2322

Configuration attribute referenceAll elements and parameters from the XML are optional. There are a few extra parameters that can also be sent. The f

XML elementXML attributeequivalent POST paramAllowed valuesNotes<Tracking />burstTransmitFreqtrackingBurstTransmitFreq12510153060How often will

XML elementXML attributeequivalent POST paramAllowed valuesNotes<Alert />deadManStatealertDeadManStateonoffWhether the dead man alert function i

XML elementXML attributeequivalent POST paramAllowed valuesNotes<Alert />temperatureColdalertTemperatureCold-40-35-30-25-20-15-10-50510152025303

XML elementXML attributeequivalent POST paramAllowed valuesNotes<Alert />temperatureHotalertTemperatureHot-40-35-30-25-20-15-10-5051015202530354

XML elementXML attributeequivalent POST paramAllowed valuesNotes<Alert />geofenceCentrealertGeofenceCentreyesnoIf this is set to ‘yes’, it instr

XML elementXML attributeequivalent POST paramAllowed valuesNotes<ScreenLock />stealthModeStatestealthModeStateonoffWhether stealth mode is enabl

BackgroundThe RockSTAR XML API enables remote systems to interact with the RockSTAR satellite communication service. It is intended to allow integrat

Push APIThe Push API will send every mobile-originated message from a device to your own web service as an HTTP POST. The parameters included in the

ParameterDescriptionExample/Possible valuesatGPS timestamp of transmitted position.e.g. 2014-02-14T13:54:48Ziridium_longitudeThe approximate longitude

ParameterDescriptionExample/Possible valuessogSpeed over grounde.g. 0.1cogCourse over grounde.g. 302altGPS altitude (in metres)e.g. 22tempTemperaturee

Position ReportsTo return ALL positions for ALL devices in your account:https://secure.rock7mobile.com/API2/GetPositions?username=xxxx&password=yy

AlertsIf a tracker transmits an 'alert' message, you will now see an"alert='true'"parameter, as well as an"alertTyp

MO (Mobile Originated) MessagesYou will receive MO messages in the same way that you receive position reports, by calling /GetPositions"An exampl

MT (Mobile Terminated) MessagesTo send a message to a device, you need to call /SendMessage"Note: this must be an HTTP POST. "GET won't