docs/CoachingApi.md in purecloudplatformclientv2-94.0.0 vs docs/CoachingApi.md in purecloudplatformclientv2-95.0.0
- old
+ new
@@ -590,11 +590,11 @@
<a name="get_coaching_notification"></a>
-## [**CoachingNotification**](CoachingNotification.html) get_coaching_notification(notification_id)
+## [**CoachingNotification**](CoachingNotification.html) get_coaching_notification(notification_id, opts)
Get an existing notification
@@ -624,14 +624,17 @@
api_instance = PureCloud::CoachingApi.new
notification_id = "notification_id_example" # String | The ID of the notification.
+opts = {
+ expand: ["expand_example"] # Array<String> | Indicates a field in the response which should be expanded.
+}
begin
#Get an existing notification
- result = api_instance.get_coaching_notification(notification_id)
+ result = api_instance.get_coaching_notification(notification_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling CoachingApi->get_coaching_notification: #{e}"
end
```
@@ -639,10 +642,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**notification_id** | **String**| The ID of the notification. | |
+ **expand** | [**Array<String>**](String.html)| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: appointment |
{: class="table table-striped"}
### Return type
@@ -688,11 +692,12 @@
api_instance = PureCloud::CoachingApi.new
opts = {
page_number: 1, # Integer | Page number
- page_size: 25 # Integer | Page size
+ page_size: 25, # Integer | Page size
+ expand: ["expand_example"] # Array<String> | Indicates a field in the response which should be expanded.
}
begin
#Retrieve the list of your notifications.
result = api_instance.get_coaching_notifications(opts)
@@ -706,9 +711,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page_number** | **Integer**| Page number | [optional] [default to 1] |
**page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **expand** | [**Array<String>**](String.html)| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: appointment |
{: class="table table-striped"}
### Return type