Report a device current location to the Campaign Manager. It's supposed to be used from your App if you are developing yours.
This method needs to be invoked as a reaction of calling the Request Device Location method
Parameters on the following URL are inside braces { }
{base_url}/rest/api/tools/sendLocation/{instanceId}/{requestId}/{deviceId}/{date}/{latitude}/{longitude}/{publicKey}/{signature}
| Parameter Name | Description |
|---|---|
| instanceId | An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login |
| requestId | This the request identifier. Originated by the Request Device Information method |
| deviceId | The if of the device sending the location information |
| date | The current time & date. formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference |
| latitude | The point latitude Number (decimal notation) |
| longitude | The point longitude Number (decimal notation) |
| publicKey | The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login |
| signature | The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example |
The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.
<input>sendLocation</input> <status>OK</status> <description>Completed</description> <result> <transactionResult> <successful>true</successful> <message>Successful registration</message> </transactionResult> </result>
| Parameter Name | Description | Possible Values |
|---|---|---|
| successful | Indicates if the location was requested ok or not | true false |
| message | A human readable explanation | Text |