diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index 0b3ff0ae..277765c5 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -44,6 +44,26 @@ info: - the Access Token `sinkCredential` (optionally set by the requester) expiration time has been reached - the API server has to stop sending notification prematurely + **Note on combined usage of ``initialEvent`` and ``subscriptionMaxEvents``**: + + If an event is triggered following ``initialEvent`` set to true, + this event will be counted towards ``subscriptionMaxEvents`` (if provided). + + + **Clarification on ``initialEvent`` & ``event-type`` behaviour:** + + Following table illustrate behaviour regarding event triggering depending on **initial** reachability state of the device: + + | subscribed event-type | device reachability status at subscription time | event sent if ``initialEvent`` set to true | Explanation | + | ----------------------| ------------- | --------------- | ---------------| + | reachability-data | Device can use data | Yes | The device is reachable for data, so the event is triggered. | + | reachability-data | Device is disconnected or SMS-only | No | The device cannot use data, so no event is sent. | + | reachability-sms | Device can use data | No | The device can use data, but for thids event is only for SMS. | + | reachability-sms | Device is SMS-only | Yes | The device supports SMS, so the event is triggered. | + | reachability-sms | Device is disconnected | No | The device cannot send SMS, so no event is send. | + | reachability-disconnected | Device can use data or SMS usage | No | The device is reachable, so no "disconnected" event is sent. | + | reachability-disconnected | Device is disconnected | Yes | The device is disconnected, so the event is triggered. | + ### Notifications callback This endpoint describes the event notification received on subscription listener side when the event occurred. diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml index 678a32d9..8cd6caa6 100644 --- a/code/API_definitions/device-roaming-status-subscriptions.yaml +++ b/code/API_definitions/device-roaming-status-subscriptions.yaml @@ -46,6 +46,44 @@ info: - the Access Token `sinkCredential` (optionally set by the requester) expiration time has been reached - the API server has to stop sending notification prematurely + **Note on combined usage of ``initialEvent`` and ``subscriptionMaxEvents``**: + + If an event is triggered following ``initialEvent`` set to true, + this event will be counted towards ``subscriptionMaxEvents`` (if provided). + + **Clarification on ``initialEvent`` & ``event-type`` behaviour:** + + Following table illustrate behaviour regarding event triggering depending on **initial** roaming state of the device: + + | subscribed event-type | device roaming status at subscription time | event sent if ``initialEvent`` set to true | + | ----------------------| ------------- | --------------- | + | roaming-status | Roaming On | Yes | + | roaming-status | Roaming Off | Yes | + | roaming-on | Roaming On | Yes | + | roaming-on | Roaming Off | No | + | roaming-off | Roaming On | No | + | roaming-off | Roaming Off | Yes | + | roaming-change-country | Roaming Off | No(*) | + | roaming-change-country | Roaming On | No(*) | + + (*) Use of ``initialEvent`` has no impact on roaming-change-country event-type. + + **Clarification on ``roaming-change-country`` event-type:** + + ``roaming-change-country`` event is sent only when the device stays in roaming situation and change country. + Suppose a device from Germany & all event types subscribed: + + - Device moves from Germany to France: + - triggered: roaming-status & roaming-on + - not triggered: roaming-change-country & roaming-off + - Device moves from France to Belgium: + - triggered: roaming-change-country + - not triggered: roaming-status, roaming-on & roaming-off + - Device moves from Belgium back to Germany + - triggered: roaming-status & roaming-off + - not triggered: roaming-on & roaming-change-country + + ### Notifications callback This endpoint describes the event notification received on subscription listener side when the event occurred.