//[[restapi:start|RESTful API]]//

====== Send Location (Tag 34) ======

==== Overview ====

Report a device current location to the Campaign Manager. It's supposed to be used from your App if you are developing yours.

<WRAP round tip>
This method needs to be invoked as a reaction of calling the [[geo#request_device_location|Request Device Location]] method
</WRAP>

==== URL ====

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 [[misc:otto|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 [[geo#request_device_information|Request Device Information]] method |
| deviceId | The if of the device sending the location information | 
| date | The current time & date. <wrap info>formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** For more information please review the [[restapi:appx_date#date_format_-_pattern_letters|pattern letters]] quick reference</wrap> |
| latitude | The point latitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap> |
| longitude | The point longitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

==== Response ====

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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| successful | Indicates if the location was requested ok or not | <color blue>true</color> \\ <color red>false</color> |
| message | A human readable explanation | Text |