docs/GeolocationApi.md in purecloudplatformclientv2-34.0.0 vs docs/GeolocationApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -16,17 +16,23 @@
<a name="get_geolocations_settings"></a>
## -[**GeolocationSettings**](GeolocationSettings.html) get_geolocations_settings
+
+
Get a organization's GeolocationSettings
Wraps GET /api/v2/geolocations/settings
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -69,17 +75,23 @@
<a name="get_user_geolocation"></a>
## -[**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
+
+
Get a user's Geolocation
Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -131,17 +143,23 @@
<a name="patch_geolocations_settings"></a>
## -[**GeolocationSettings**](GeolocationSettings.html) patch_geolocations_settings(body)
+
+
Patch a organization's GeolocationSettings
Wraps PATCH /api/v2/geolocations/settings
+Requires ANY permissions:
+* telephony:plugin:all
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -190,14 +208,20 @@
<a name="patch_user_geolocation"></a>
## -[**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
+
+
Patch a user's Geolocation
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
+
+Requires NO permissions:
+
+
### Example
~~~ruby
# load the gem