Quality-of-service-on-Demand (QoD) notifications

On this page, you will find the JSON schema for QoD notifications, which purpose is to monitor changes made to sessionId, qosStatus and statusInfo. Underneath the JSON schema, there is a table with further information on the specific keyword values.

Remember that the string values represented below are just examples that can be used. So, they should contain your real QoD session values.

QoD-notification `JSON` schema

{
  "event": {
    "eventType": {
      "const": "QOS_STATUS_CHANGED"
    },
    "eventTime": "2023-01-17T13:18:23.682Z",
    "eventDetail": {
      "sessionId": "session-01",
      "qosStatus": "REQUESTED | AVAILABLE | UNAVAILABLE",
      "statusInfo": "DURATION_EXPIRED | NETWORK_TERMINATED"
    }
  }
}

QoD-keyword values	Description
`eventSubscriptionId`	A string value with the event subscription identifier.
`event`	An object, which contains other objects or strings with further details on the event.
`eventType`	A string value containing the different status you want to check. The keyword `const` restricts to a single value, which is `"QOS_STATUS_CHANGED"`. So, the notifications relate to the changes in QoD sessions, such as ID, QoS status and expiration changes.
`eventTime`	A string value with the time the event occurred. Date and time are specified in ISO 8601 format, e.g.: `2023-08-20T21:01:02.345Z`.
`eventDetail`	An object that contains three other string types, which are `sessionId`, `qosStatus` and `statusInfo`. The different `JSON` schemas for these strings are exemplified above.
`sessionId`	A string value containing the session resource ID. It can be a session name or number, which is attributed when you create a session.
`qosStatus`	A string value with the QoS profile status, whether it is `REQUESTED`, `AVAILABLE`, `UNAVAILABLE`.
`statusInfo`	An optional string value providing information on the QoD session expiration or termination due to the network. The accepted values are: `DURATION_EXPIRED`, `NETWORK_TERMINATED` or it can also be empty (null).

Last updated on November 27, 2023