Network as CodeQuality-of-service-on-Demand (QoD) notification details
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
{
"id":"string",
"source":"string",
"type":"org.camaraproject.qod.v0.qos-status-changed",
"specversion":"1.0",
"datacontenttype":"application/json",
"time":"2024-04-30T13:05:29.189Z",
"event":{
"eventType":"QOS_STATUS_CHANGED",
"eventTime":"string",
"eventDetail":{
"sessionId":"string",
"qosStatus":"AVAILABLE",
"statusInfo":"DURATION_EXPIRED"
}
},
"data":{
"sessionId":"string",
"qosStatus":"AVAILABLE",
"statusInfo":"DURATION_EXPIRED"
}
}| QoD-keyword values | Description |
|---|---|
id | A string value with the event subscription identifier. |
source | A string value that identifies the source where the event happened. It contains the Network as Code API implementation and subscription ID. |
type | A string value returned by the API with different statuses. |
specversion | A string representing the specification version. |
datacontenttype | It indicates the media type for the event payload encoding. It must be "application/json" in the context of CAMARA APIs |
time | 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. |
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. This value should always be "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 QoD session 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 July 09, 2024