The URI of the northbound API is specified in the following format:

Transcription

1 URI, on page 1 Session Identifier, on page 1 Update QoS Sessions and Methods, on page 1 Update QoS Request Fields, on page 3 Intent Parameter for Default Bearer, on page 9 /network/define/qostype/version on page 10 /network/define/qostype/version/sessionid, on page 26 URI The URI of the northbound is specified in the following format: where, api_path: REST that is requested. The api_path of the QoS is /network/define/qostype. version: Version of the published/subscribed REST. Session Identifier In case of PUT, DELETE and GET methods for operation on unique session, additionally session identifier needs to be appended to the URI: identifier> Update QoS Sessions and Methods Update QoS supports dynamic changes to the subscriber QoS, bandwidth, and sponsored data. Each session includes a request, synchronous response, and a callback. Each request uses a specific HTTP method. The following table describes the Update QoS sessions and the respective methods: 1

2 Session Creation Table 1: Update QoS Sessions and Methods For the following sessions: Create session for Update QoS Update an existing session Delete an existing session Read details of an existing session Use the following method POST PUT DELETE GET Session Creation Session Update Session Delete The following section describes each of the sessions: A unique session identifier is associated with each session. If multiple APNs exist, then a session is created for each APN. Use the PUT method to update an existing session. Append the session identifier at the end of the URL. The DELETE method is used to delete an existing session. You must append the session identifier at the end of the URI. e A session deletion can also be triggered by MOG when the duration of the QoS definition, as specified in the create/update request, of the session completes. Session Read The GET method is used to query sessions in the MOG system. You must append the unique session identifier at the end of the URI. You can query for a list of sessions using the base URI and providing the following one or both of the query parameters: address as defined in the create request table apn as defined in the create request table. You can also specify token for the callback as defined in the create request table. Update QoS Submission Response On receiving the request, MOG validates the JSON syntax. If the syntax is valid, MOG submits the request and responds with a 200 (OK) status code. 2

3 Update QoS Request Fields If the validation fails, then a 400 (BAD REQUEST) status code is sent immediately with a JSON describing the reason for failure. If the api_path of the URI does not match the supported paths, then a 404 (NOT FOUND) status code is sent. Update QoS Request Fields The following tables describe the mandatory and optional fields used in the JSON payload of the Update QoS request: Table 2: Update QoS Request Fields Mandatory Fields Variable Type Description address msisdn-var imsi-var ipv4 string Subscriber address in any one of the following formats: E164 encoded MSISDN: "address":"tel:+<msisdn>" ipv6 IMSI: "address":"imsi:<imsi>" acr-string IPv4: "address":"ipv4:<ipv4-dotted-quad>" IPv6: "address":"ipv6:<ipv6-address> Acr: address:acr:<acr value> Optional Fields Variable Type Description 3

4 Update QoS Request Fields Mandatory Fields Variable Type Description qci qci-var uint8 QoS Class Indicator with a range of 1 to 9. If not specified in JSON, the value is picked from the use case template of Policy Builder. QCI of 1 to 4 is used for guaranteed bit rates. The QCI value is Mapped to Media Type before sending to PCRF. The Media-Type AVP is used by the PCRF to derive the QCI. The AVP values can be found in 3GPP TS The following QCI values describe the mapping of QCI to Media-Type: QCI of 1 indicates Media-Type of Audio QCI of 2 indicates Media-Type of Video QCI of 3 or 4 indicates Media Type of Application QCI of 5 indicates Media Type of Control QCI of 6, 7, 8 indicates Media Type of Data QCI of 9 indicates Media Type of Other For a default bearer, the QCI values indicate: QCI 1 and 2 indicates Conversational QCI 3 and 4 indicates Streaming QCI 5,6,7, and 8 indicates Interactive QCI 9 indicates Background maxbitrate maxbitrate-var object Maximum bit rate in Kbps for uplink and downlink. If this field is not supplied, the value configured in Service Configuration of the will be used. uplink uplink-var uint64 Upload rate in Kbps. 4

5 Update QoS Request Fields Mandatory Fields Variable Type Description downlink downlink-var uint64 Download rate in Kbps. flows flows-var string Flows to be applied on the bearer. Multiple flows are included as objects in the array. Each object will have following fields: srcaddress srcport srcportlist srcportranges destaddress destport destportlist destportranges protocol srcaddress src-ip-address-var string IPv4 or IPv6 address of user equipment (UE). srcport src-port-var string IP port of UE. srcportlist src-port-list-var string IP port list of UE. srcportranges src-port-ranges-var string IP port ranges of UE. destaddress dest-ip-address-var string IPv4 or IPv6 address of app server. This field is mandatory for each flow entry. destport dest-port-var string IP port of application server. destportlist dest-port-list-var string IP port list of application server. destportranges dest-port-ranges-var string IP port ranges of application server. protocol protocol-var uint32 Transport protocol number (as per IANA) used by application 5

6 Update QoS Request Fields Mandatory Fields Variable Type Description duration duration-var uint32 Duration in seconds of QoS definition for the end user subscriber. When duration is specified, the session is terminated on the completion of the duration value. If duration is not provided, the session will last till an explicit DELETE is issued. volume volume-var uint64 Maximum amount of data in bytes for which the QoS change should be maintained. sponsorid sponsor-id-var string The name of the sponsor for the QoS change. If this field is supplied, the sponsor organization will be associated with the QoS change (also for billing purposes). apn apn-var string APN associated for the request. If not supplied, the value is considered from the onboarding database. The onboarding database supports maximum of 5 APNs. An request without APN field results in QoS updates for all the configured APNs in the onboarding database. If the subscriber address is in ACR format, APN information is part of the ACR address. callback callback-var string A URI for receiving status updates. If this field is supplied, the specified URI will be called when the status of the requested QoS session changes. If not supplied, callback value is considered from the configuration. Both http and https are supported in callback URI. uri uri-var uint8 A uniform resource identifier string. token token-var string A token string, not to be interpreted by the server but returned to the caller in responses. 6

7 Update QoS Request Fields Mandatory Fields Variable Type Description arp arp-var Object If supplied, indicates the Priority of Allocation and Retention for the corresponding APN configuration of the default/dedicated bearer. priority priority-var uint8 Used to decide whether a bearer establishment or modification request can be accepted or needs to be rejected, in case of resource limitations. Priority is also used to decide which existing bearers may be pre-empted during resource limitations. The priority level defines the relative importance of a resource request and takes a range of values from 1 to 15 with 1 as the highest level of priority. The AVP details can be found in 3GPP TS preemptioncapability pre-emption-capability-var boolean Determines whether a bearer can use resources from another bearer with a lower priority and is usually set for emergency services. preemptionvulnerability pre-emption-vulnerabilityvar boolean Determines whether a bearer can give up resources to a bearer with a higher priority. 7

8 Update QoS Request Fields Mandatory Fields Variable Type Description intent Intent-var Object Indicates the Intention and Priority for the QoS. You can assign the following Intention values to modify the bandwidth: BOOST: Increases the QoS (QCI, ARP, Bandwidth) of the subscriber. Cisco Policy Suite selects the higher value of the applied vs. requested QoS. THROTTLE: Decreases the QoS (QCI, ARP, Bandwidth) of the subscriber. Cisco Policy Suite selects the lower value of the applied vs. requested QoS. REFRESH : Refreshes the CC-Time of the session with configured duration value from create session or validity time configured for the tenant and sponsor ID pair in Policy Builder MOG Configuration plugin. e case sensitive You can also assign the Priority of an Intention(positive integer). When multiple Rx sessions exist, Cisco Policy Suite decides whether to apply Intention or not by comparing the priority value. A higher value means lowest priority. dpcc dpcc-var Object Dynamic PCC includes two attributes: name and value. Both name and value of DPCC are used to evaluate CRD table to get PCC rule. starttime Starttime-var Object Which takes year, month, day, hour, minutes and seconds. This starttime indicates session starttime. 8

9 Intent Parameter for Default Bearer Intent Parameter for Default Bearer You can specify the intent parameter (either boost or throttle) of the QoS modification of default bearer along with the priority. Service-Status-Info AVP value in AAR is set to PRELIMINARY_SERVICE_INFO to allow PCRF to install charging rule on the modified default bearer. The following table lists the result of different parameters passed in the request: Table 3: Parameters Passed in the Request Result Intent QCI Bitrate Bitrate QCI QoS APN APN (uplink) (downlink) (Default (Charging AMBR AMBR Bearer) Rule) (uplink) (downlink) Boost/None New Charging Rule Boost/None New Charging Rule Boost/None New Charging Rule Boost/None New Charging Rule Boost/None Charging Rule Boost/None Charging Rule Boost/None Charging Rule Boost/None Charging Rule 9

10 /network/define/qostype/version Result Intent QCI Bitrate Bitrate QCI QoS APN APN (uplink) (downlink) (Default (Charging AMBR AMBR Bearer) Rule) (uplink) (downlink) Throttle New Charging Rule Throttle New Charging Rule Throttle New Charging Rule Throttle New Charging Rule Throttle Charging Rule Throttle Charging Rule Throttle Charging Rule Throttle Charging Rule /network/define/qostype/version POST URL: /network/define/qostype/version Description: Create session to update subscriber QoS, bandwidth boost Security Schemes: Bearer 10

11 Request Headers Authorization Authorization Header has the token as string with value "Bearer token string" Request URI Parameters version: required (string) Body Type: application/json Schema "description":"create Qos", "properties": "qostype": "decription":"qostype", "properties": "address": "description":"msisdn or IMSI of the subscriber",, "pattern":"tel:\\+[0-9]+ [0-9]+" or imsi:[0-9] + or ipv4:"^((25[0-5] 2[0-4][0-9] [01]?[0-9][0-9]?)\\.)3(25[0-5] 2[0-4][0-9] [01]?[0-9][0-9]?)$" or ipv6:"([0-9a-f]1,4:)7([0-9a-f])1,4" or acr:"[0-9a-fa-f]+[-]1[0-9a-fa-f;=]+" "qci": "description":"qos class indicator", "type":"integer", "minimum":1, "maximum":9 "apn": "description":"list of APNs", "type":"array", "items": "maxbitrate": "description":"max bit rate", "properties": "uplink": "description":"upload rate in kbps", "downlink": "description":"download rate in kbps", "flows": "description":"application server and UE details", "type":"array", 11

12 Request "properties": "destaddress": "description":"application server ip address", "type":["ipv4","ipv6"] "destport": "description":"application server port number", "destportlist": "description":"list of Application server port numbers", "type":"array", "items": "destportranges": "description":"ranges of Application server port numbers", "type":"array", "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "srcaddress": "description":"ue ip address", "type":["ipv4","ipv6"] "srcport": "description":"ue port number", "srcportlist": "description":"list of UE port numbers", "type":"array", "items": "srcportranges": "description":"ranges of UE port numbers", "type":"array", "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "protocol": "description":"application server protocol", "type":"integer", "minimum":0, "maximum":255 12

13 Request "required":["destaddress"] "duration": "description":"duration of the QoS in Seconds", "volume": "description":"count of data in bytes", "sponsorid": "description":"sponsors identifier", "callback": "description":"callback information", "properties": "uri": "description":"callback URI", "type":"uri" "token": "description":"token identifier", "arp": "description": "Bearer ARP details", "properties": "priority": "description": "Priority order for modifying the bearer", "type": "positive integer" "pre-emption-capability": "description":"indicates if bearer can grab resources", "type":"boolean" "pre-emption-vulnerability": "description":"indicates if bearer can loose resources", "type":"boolean" "intent": "description": "Custom grouped AVP", "type": "object", "properties": "intention": "description": "Custom AVP, (either BOOST or THROTTLE ) "priority": "description": "Custom AVP", "type":"positive integer" "dpcc": "description": "Custom identifier", 13

14 Request "type": "object", "properties": "name": "description": "name identifier, "value": "description": "value identifier", "type":"string" "starttime": "description": "Indicates session starttime", "type": "object", "properties": "year": "description": "year of starttime, "type": "positive integer "month": "description": "month of starttime, "type": "positive integer "day": "description": "day of starttime, "type": "positive integer "hour": "description": "hour of starttime, "type": "positive integer "minutes": "description": "minutes of starttime, "type": "positive integer "seconds": "description": "seconds of starttime, "type": "positive integer "required":["address"] Example "qostype": "address": "acr:868dbd- 285BE3560A3FD5941C7CE1E77999BD3B50A54F545A96AACF537A B3A923295C0927E2F990EF B91B;ncc=310410;type=Static", "flows": [ "srcaddress": " /24", "srcport": 8182, "destaddress": " /24", "destport": 7173, "protocol": 17 14

15 Response ], "maxbitrate": "uplink":10, "downlink":20 "callback": "uri": " "token": " " "duration": 3600 Response HTTP status code: 200 Body Type: application/json Schema: "description":"update Qos", "type":"array", "items": "description":"session object", "properties": "qostype": "decription":"qostype", "properties": "address": "description":"msisdn or IMSI of the subscriber", "qci": "description":"qos class indicator", "type":"integer", "minimum":1, "maximum":9 "apn": "description":"list of APNs", "type":"array", "items": "maxbitrate": "description":"max bit rate", "properties": "uplink": "description":"upload rate in kbps", "downlink": "description":"download rate in kbps", 15

16 Response "flows": "description":"application server and UE details", "type":"array", "properties": "destaddress": "description":"application server ip address", "type":[ "ipv4", "ipv6" ] "destport": "description":"application server port number", "destportlist": "description":"list of Application server port numbers", "type":"array" "items": "destportranges": "description":"ranges of Application server port numbers", "type":"array" "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "srcaddress": "srcportlist": "items": "description":"ue ip address", "type":[ "ipv4", "ipv6" ] "srcport": "description":"ue port number", "description":"list of UE port numbers", "type":"array" "srcportranges": "description":"ranges of UE port numbers", "type":"array" "items": "start": "description":"start of port number range", 16

17 Response "end": "dpcc": "description":"end of port number range", "protocol": "description":"application server protocol", "type":"integer", "minimum":0, "maximum":255 "duration": "description":"duration of the QoS in Seconds", "volume": "description":"count of data in bytes", "sponsorid": "description":"sponsors identifier", "callback": "description":"callback information", "properties": "uri": "description":"callback URI", "type":"uri" "token": "description":"token identifier", "arp": "description": "Bearer ARP details", "type": "object", "properties": "priority": "description": "Priority order for modifying the bearer", "type": "positive integer" "pre-emption-capability": "description": "Indicates if bearer can grab resources", "type": "boolean" "pre-emption-vulnerability": "description": "Indicates if bearer can loose resources", "type": "boolean" "description": "Custom identifier", "type": "object", "properties": "name": "description": "name identifier, 17

18 Response "\": "value": "description": "value identifier", "type":"string" "description": "Custom grouped AVP", "type": "object", "properties": "intention": "description": "Custom AVP, (either BOOST or THROTTLE ), "priority": "description": "Custom AVP", "type":"positive integer" "qosstatus": "description":"qos status", "properties": "sessionid": "description":"unique session identifier", "status": "description":"value of defined or ended", "status-report": "description":"detailed status report", "properties": "Allocation-Retention-Priority": "description":" Allocation-Retention-Priority status received from PCRF, values can be success/failure/ignored ", "QoS-Class-Identifier": "description":"qos-class-identifier status received from PCRF, values can be success/failure/ignored ", "APN-Aggregate-Max-Bitrate-DL": "description":" APN-Aggregate-Max-Bitrate-DL status received from PCRF, values can be success/failure/ignored ", "APN-Aggregate-Max-Bitrate-UL": "description":" APN-Aggregate-Max-Bitrate-UL status received from PCRF, values can be success/failure/ignored ", "validitytime": "description":"session Validity Time in Seconds", "type":" positive integer " 18

19 Curl Example Curl Example Command for : curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92w Et2yvvGJJc0Q1SqYB6JVyF1GdVK5jL4GKqkcAu/ZL4IgrH5OVVsV7cvq07JlLcs7XRG 8HqsS70tlb1nx9gwev2EpY7GB2Llamup8y5Tod9SQopc/xSIw==" -X POST :// :6443/api/network/define/qosType/1.0 --data "@qos.acr.json" Curl response: ["sessionid":" e-37f6-4e81-bba2-5fef45579d28mog11", "address":"acr:c f-4d3e09ae09a3406f9852a99e20664d5823aa2677ae 465C27BCE1D8F474F474AF5A5DDBF87704D7DBDF76A6A9D CE6A4B0B21BCD FDE1116CFBDE3515;ncc=310410;type=Static","code":200] Callback response: "qosstatus" : "sessionid" : " e-37f6-4e81-bba2-5fef45579d28MOG11", "address" : "acr:c f-4d3e09ae09a3406f9852a99e20664d5823aa2677ae465c27bce1d8f474f474a F5A5DDBF87704D7DBDF76A6A9D CE6A4B0B21BCDFDE1116CFBDE3515;ncc=310410;type=Static", "status" : "defined" Input JSON: "qostype": "address": "acr:c f-4d3e09ae09a3406f9852a99e20664d5823aa2677ae465c27bce1d8f474f474af5a5ddbf87704d7dbdf76a6a9d ce6a4b0b21bcdfde1116cfbde3515;ncc=310410;type=static", "maxbitrate": "uplink":20, "downlink":30 "duration":30, "qci": "5", "callback": "uri": " "token": " " GET URL: /network/define/qostype/version Description: Query existing sessions Security Schemes: 19

20 Request Bearer Headers Authorization Authorization Header has the token as string with value "Bearer token string" Request URI Parameters version: required (string) Query Parameters address: (string) Address of the subscriber apn: (string) APN token: (string) Callback token passed in the create session request. Response HTTP status code: 200 Body Type: application/json Schema: "description":"update Qos", "type":"array", "items": "description":"session object", "properties": "qostype": "decription":"qostype", "properties": "address": "description":"msisdn or IMSI of the subscriber", "qci": "description":"qos class indicator", "type":"integer", "minimum":1, "maximum":9 "apn": "description":"list of APNs", 20

21 Response "type":"array", "items": "maxbitrate": "description":"max bit rate", "properties": "uplink": "description":"upload rate in kbps", "downlink": "description":"download rate in kbps", "flows": "description":"application server and UE details", "type":"array", "properties": "destaddress": "description":"application server ip address", "type":[ "ipv4", "ipv6" ] "destport": "description":"application server port number", "destportlist": "description":"list of Application server port numbers", "type":"array" "items": "destportranges": "description":"ranges of Application server port numbers", "type":"array" "items": "start": "description":"start of port number range", "end": "srcaddress": "description":"end of port number range", "description":"ue ip address", "type":[ "ipv4", "ipv6" ] "srcport": "description":"ue port number", 21

22 Response "srcportlist": "items": "description":"list of UE port numbers", "type":"array" "srcportranges": "description":"ranges of UE port numbers", "type":"array" "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "protocol": "description":"application server protocol", "type":"integer", "minimum":0, "maximum":255 "duration": "description":"duration of the QoS in Seconds", "volume": "description":"count of data in bytes", "sponsorid": "description":"sponsors identifier", "callback": "description":"callback information", "properties": "uri": "description":"callback URI", "type":"uri" "token": "description":"token identifier", "arp": "description": "Bearer ARP details", "type": "object", "properties": "priority": "description": "Priority order for modifying the bearer", "type": "positive integer" 22

23 Response "dpcc": "\": "pre-emption-capability": "description": "Indicates if bearer can grab resources", "type": "boolean" "pre-emption-vulnerability": "description": "Indicates if bearer can loose resources", "type": "boolean" "description": "Custom identifier", "type": "object", "properties": "name": "description": "name identifier, "value": "description": "value identifier", "type":"string" "description": "Custom grouped AVP", "type": "object", "properties": "intention": "description": "Custom AVP, (either BOOST or THROTTLE ), "priority": "description": "Custom AVP", "type":"positive integer" "qosstatus": "description":"qos status", "properties": "sessionid": "description":"unique session identifier", "status": "description":"value of defined or ended", "status-report": "description":"detailed status report", "properties": "Allocation-Retention-Priority": "description":" Allocation-Retention-Priority status received from PCRF, values can be success/failure/ignored ", "QoS-Class-Identifier": "description":"qos-class-identifier status received from PCRF, values can be success/failure/ignored ", 23

24 Curl Example "APN-Aggregate-Max-Bitrate-DL": "description":" APN-Aggregate-Max-Bitrate-DL status received from PCRF, values can be success/failure/ignored ", "APN-Aggregate-Max-Bitrate-UL": "description":" APN-Aggregate-Max-Bitrate-UL status received from PCRF, values can be success/failure/ignored ", "validitytime": "description":"session Validity Time in Seconds", "type":" positive integer " Curl Example Curl command to get session: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X GET Curl response: [ "qostype" : "address" : "acr:c f- 4D3E09AE09A3406F9852A99E20664D5823AA2677AE465C27BCE1D8F474F474AF5A5DDBF87704D7DBDF76A6A 9D CE6A4B0B21BCDFDE1116CFBDE351;ncc=310410;type=Static", "qci" : 5, "maxbitrate" : "uplink" : 20, "downlink" : 30 "duration" : 30, "callback" : "uri" : " "token" : " " "qosstatus" : "sessionid": "c2cfe529-90e4-4ff0-b1fa-86bc9e15c1fcmog2", "status": "defined", validitytime :500, ] Curl response with custom status report: 24

25 Curl Example [ "qostype" : "address" : "acr:c f-4d3e09ae09a3406f9852a99e20664d5823aa2677ae465c27bce1d8f474f474af5a5ddbf87704d7dbdf76a6a9d ce6a4b0b21bcdfde1116cfbde3515;ncc=310410;type=static", ] "qci" : 5, "maxbitrate" : "uplink" : 20, "downlink" : 30 "duration" : 30, "callback" : "uri" : " "token" : " " "qosstatus" : "sessionid": "c2cfe529-90e4-4ff0-b1fa-86bc9e15c1fcmog2", "status": "defined", validitytime :500, "status" : "ok" Curl response with detailed status report: [ ] "qostype" : "address" : "imsi: ", "apn" : [ "cisco.com" ], "flows" : [ "destaddress" : " /24", "destport" : 1221, "srcaddress" : " /24", "srcport" : 2230, "protocol" : 17 ], "callback" : "uri" : " "token" : " " "duration" : 60, "dpcc" : "name" : "DPCC-1", "value" : "2" "qosstatus" : "sessionid" : " D6F672D C ", "validitytime" : 45, "status" : "ok", "detailed-report": "bitrate-uplink": "success", "bitrate-downlink": "success", "qci": "success", "arp": "success" 25

26 /network/define/qostype/version/sessionid /network/define/qostype/version/sessionid PUT URL: /network/define/qostype/version/sessionid Description: Update an existing session Security Schemes: Bearer Headers Authorization Authorization Header has the token as string with value "Bearer token string" Request URI Parameters version: required (string) Body sessionid: required (string) Type: application/json Schema: "description":"update Qos", "properties": "qostype": "decription":"qostype", "properties": "maxbitrate": "description":"max bit rate", "properties": "uplink": "description":"upload rate in kbps", "downlink": "description":"download rate in kbps", "flows": "description":"application server and UE details", "type":"array", 26

27 Request "properties": "destaddress": "description":"application server ip address", "type":["ipv4","ipv6"] "destport": "description":"application server port number", "destportlist": "description":"list of Application server port numbers", "type":"array", "items": "destportranges": "description":"ranges of Application server port numbers", "type":"array", "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "srcaddress": "description":"ue ip address", "type":["ipv4","ipv6"] "srcport": "description":"ue port number", "srcportlist": "description":"list of UE port numbers", "type":"array", "items": "srcportranges": "description":"range of UE port numbers", "type":"array", "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "protocol": "description":"application server protocol", "type":"integer", "minimum":0, "maximum":255 27

28 Request "dpcc": "intent": "required":["destaddress"] "duration": "description":"duration of the QoS in Seconds", "volume": "description":"count of data in bytes", "qci": "description":"qos class indicator", "type":"integer", "minimum":1, "maximum":9 "arp": "description": "Bearer ARP details", "type": "object", "properties": "priority": "description": "Priority order for modifying the bearer", "type": "positive integer" "pre-emption-capability": "description": "Indicates if bearer can grab resources", "type":"boolean" "pre-emption-vulnerability": "description": "Indicates if bearer can loose resources", "type": "boolean" "description": "Custom grouped AVP", "type": "object", "properties": "intention": "description": "Custom AVP, (either BOOST or THROTTLE or REFRESH ) "priority": "description": "Custom AVP", "type":"positive integer" "description": "Custom identifier", "type": "object", "properties": "name": "description": "name identifier, "value": "description": "value identifier", "type":"string" 28

29 Response Response HTTP status code: 200 Body Type: application/json Schema: "description":"update QoS submission response", "type : object", "properties": "sessionid": "description":"unique identifier of the session", "code": "description":"status code 200 or 400 or 401", "type":"integer" "message": "description":"only in case of error", "required":["code"] Example: "sessionid": "f a4-8aaf-6d23f2a5c47fmog1", "code": 200, HTTP status code: 400 Body Type: application/json Example: "code": 400, "message": "Unrecognized field [name] in JSON request." HTTP status code: 401 Body Type: application/json Example: 29

30 Curl Example "code": 401, "message": "Authentication Failure" HTTP status code: 404 Body Type: application/json Curl Example DELETE Curl command for update of session: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X PUT --data Curl response: "sessionid": " e-37f6-4e81-bba2-5fef45579d28MOG11", "code": 200 Callback: "qosstatus" : "sessionid" : " e-37f6-4e81-bba2-5fef45579d28MOG11", "address" : "acr:c f- 4D3E09AE09A3406F9852A99E20664D5823AA2677AE465C27BCE1D8F474F474AF5A5DDBF87704D7DBDF76A6A9D CE6A4B0B21BCDFDE1116CFBDE3515;ncc=310410;type=Static", "status" : "defined" Input Json: "qostype": "duration":1800 URL: /network/define/qostype/version/sessionid Description: Delete an existing session Security Schemes: Bearer Headers Authorization Authorization Header has the token as string with value "Bearer token string" 30

31 Request Request URI Parameters version: required (string) sessionid: required (string) Response HTTP status code: 200 Body Type: application/json Schema: "description":"update QoS submission response", "type : object", "properties": "sessionid": "description":"unique identifier of the session", "code": "description":"status code 200 or 400 or 401", "type":"integer" "message": "description":"only in case of error", "required":["code"] Example: "sessionid": "f a4-8aaf-6d23f2a5c47fmog1", "code": 200, Curl Example Command to delete session: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X DELETE Curl Response: "sessionid":" e-37f6-4e81-bba2-5fef45579d28mog11","code":200 Callback response: "qosstatus" : "sessionid" : " e-37f6-4e81-bba2-5fef45579d28MOG11", "address" : "acr:c f- 31

32 GET 4D3E09AE09A3406F9852A99E20664D5823AA2677AE465C27BCE1D8F474F474AF5A5DDBF87704D7DBDF76A6A9D CE6A4B0B21BCDFDE1116CFBDE3515;ncc=310410;type=Static", "status" : "ended" Command to delete on version: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X DELETE Curl response: "code":405,"message":"delete is not supported on GET URL: /network/define/qostype/version/sessionid Description: Get the Session Status and other details Security Schemes: Bearer Headers Authorization Authorization Header has the token as string with value "Bearer token string" Request URI Parameters version: required (string) sessionid: required (string) Response HTTP status code: 200 Body Type: application/json Schema: "description":"update Qos", "type":"array", "items": "description":"session object", "properties": "qostype": "decription":"qostype", 32

33 Response "properties": "address": "description":"msisdn or IMSI of the subscriber", "qci": "description":"qos class indicator", "type":"integer", "minimum":1, "maximum":9 "apn": "description":"list of APNs", "type":"array", "items": "maxbitrate": "description":"max bit rate", "properties": "uplink": "description":"upload rate in kbps", "downlink": "description":"download rate in kbps", "flows": "description":"application server and UE details", "type":"array", "properties": "destaddress": "description":"application server ip address", "type":[ "ipv4", "ipv6" ] "destport": "description":"application server port number", "destportlist": "description":"list of Application server port numbers", "type":"array" "items": "destportranges": "description":"ranges of Application server port numbers", "type":"array" "items": "start": "description":"start of port number range", "end": "description":"end of port number range", 33

34 Response "srcaddress": "srcportlist": "items": "description":"ue ip address", "type":[ "ipv4", "ipv6" ] "srcport": "description":"ue port number", "description":"list of UE port numbers", "type":"array" "srcportranges": "description":"ranges of UE port numbers", "type":"array" "items": "start": "description":"start of port number range", "end": "description":"end of port number range", "protocol": "description":"application server protocol", "type":"integer", "minimum":0, "maximum":255 "duration": "description":"duration of the QoS in Seconds", "volume": "description":"count of data in bytes", "sponsorid": "description":"sponsors identifier", "callback": "description":"callback information", "properties": "uri": "description":"callback URI", "type":"uri" 34

35 Response "dpcc": "\": "token": "description":"token identifier", "arp": "description": "Bearer ARP details", "type": "object", "properties": "priority": "description": "Priority order for modifying the bearer", "type": "positive integer" "pre-emption-capability": "description": "Indicates if bearer can grab resources", "type": "boolean" "pre-emption-vulnerability": "description": "Indicates if bearer can loose resources", "type": "boolean" "description": "Custom identifier", "type": "object", "properties": "name": "description": "name identifier, "value": "description": "value identifier", "type":"string" "description": "Custom grouped AVP", "type": "object", "properties": "intention": "description": "Custom AVP, (either BOOST or THROTTLE ), "priority": "description": "Custom AVP", "type":"positive integer" "qosstatus": "description":"qos status", "properties": "sessionid": "description":"unique session identifier", "status": "description":"value of defined or ended", "status-report": 35

36 Curl Example "description":"detailed status report", "properties": "Allocation-Retention-Priority": "description":" Allocation-Retention-Priority status received from PCRF, values can be success/failure/ignored ", "QoS-Class-Identifier": "description":"qos-class-identifier status received from PCRF, values can be success/failure/ignored ", "APN-Aggregate-Max-Bitrate-DL": "description":" APN-Aggregate-Max-Bitrate-DL status received from PCRF, values can be success/failure/ignored ", "APN-Aggregate-Max-Bitrate-UL": "description":" APN-Aggregate-Max-Bitrate-UL status received from PCRF, values can be success/failure/ignored ", "validitytime": "description":"session Validity Time in Seconds", "type":" positive integer " Curl Example Curl command to get session: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X GET Curl response: [ "qostype" : "address" : "acr:c f- 4D3E09AE09A3406F9852A99E20664D5823AA2677AE465C27BCE1D8F474F474AF5A5DDBF87704D7DBDF76A6A9D CE6A4B0B21BCDFDE1116CFBDE3515;ncc=310410;type=Static", "qci" : 5, "maxbitrate" : "uplink" : 20, "downlink" : 30 "duration" : 30, "callback" : "uri" : " 36

37 Curl Example "token" : " " "qosstatus" : "sessionid": "c2cfe529-90e4-4ff0-b1fa-86bc9e15c1fcmog2", "status": "defined", validitytime :500, ] Curl command to get parent session: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X GET D2D Curl response: [ "qostype": "address": "tel: ", "apn": [ "mog3" ], "callback": "uri": " "token": "1234" "duration": 99999, "volume": 200, "dpcc": "name": "DPCC-1", "value": "1" "qosstatus": "sessionid": "6D6F E31636C D D2D D6F6733", "validitytime": 99983, "status": "accepted" "qostype": "address": "tel: ", "apn": [ "mog1" ], "callback": "uri": " "token": "1234" "duration": 99999, "volume": 200, "dpcc": "name": "DPCC-1", "value": "1" "qosstatus": 37

38 Curl Example "sessionid": "6D6F E31636C D D2D D6F6731", ] "validitytime": 99983, "status": "accepted" Curl command to get parent session when there are no child sessions: curl -k -H "Content-Type: application/json" -H "Authorization: Bearer xri8khupwqx4bpphyarpmis5szjyn3z92wet2yvvgjjc0q1sqyb6jvyf1gdvk5jl4gkqkcau/zl4igrh5ovvsv7cv q07jllcs7xrg8hqss70tlb1nx9gwev2epy7gb2llamup8y5tod9sqopc/xsiw==" -X GET D2D Curl response: [ ] "qostype": "address": "tel: ", "callback": "uri": " "token": "1234" "duration": , "volume": 200, "starttime": "year": 2017, "month": 4, "day": 24, "hour": 8, "minutes": 4, "seconds": 4 "dpcc": "name": "DPCC-1", "value": "1" 38