Npcf_SMPolicyControl

The Session Management Policy Control Service performs provisioning, update and removal of session related policies and PCC rules by the Policy Control Function (PCF) to the NF service consumer (i.e. SMF). The Session Management Policy Control Service can be used for charging control, policy control and/or application detection and control. Session Management Policy Control Service applies to the cases where the SMF interacts with the PCF in the non-roaming scenario. The V-SMF interacts with the V-PCF in the local breakout roaming scenario and the H-SMF interacts with the H-PCF in the home-routed scenario.

Reference: 3GPP TS 29.512 version 15.0.0 Release 15

OpenAPI

OpenAPI Version: 3.0.0

info

Description: Session Management Policy Control Service

Version: "1.0.0"

Title: Npcf_SMPolicyControl

externalDocs

Description: 3GPP TS 29.512 V15.2.0; 5G System; Session Management Policy Control Service.

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.512/'

security

- {}

- oAuth2Clientcredentials:

- npcf-smpolicycontrol

servers

URL: '{apiRoot}/npcf-smpolicycontrol/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501

paths

/sm-policies

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyContextData'

Responses:

'201' Created

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyDecision'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404' Not Found

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

Callbacks:

SmPolicyUpdateNotification:

'{$request.body#/notificationUri}/update':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyNotification'

Responses:

'200' OK. The current applicable values corresponding to the policy control request trigger is reported

Content:

Application/JSON:

Schema:

oneOf:

- $ref: '#/components/schemas/UeCampingRep'

- type: array

items:

Reference: '#/components/schemas/PartialSuccessReport'

minItems: 1

'204' No Content, Notification was succesfull

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/RuleReport'

'400' Bad Request.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ErrorReport'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

SmPolicyControlTerminationRequestNotification:

'{$request.body#/notificationUri}/terminate':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TerminationNotification'

Responses:

'204' No Content, Notification was succesful

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

/sm-policies/{smPolicyId}

get:

Parameters:

- name: smPolicyId

In: path

Description: Identifier of a policy association

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. Resource representation is returned

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyControl'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

/sm-policies/{smPolicyId}/update

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyUpdateContextData'

Parameters:

- name: smPolicyId

In: path

Description: Identifier of a policy association

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK. Updated policies are returned

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyDecision'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

/sm-policies/{smPolicyId}/delete

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmPolicyDeleteData'

Parameters:

- name: smPolicyId

In: path

Description: Identifier of a policy association

Required/Optional: true

Schema:

Type: string

Responses:

'204' No content

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{nrfApiRoot}/oauth2/token'

scopes:

npcf-smpolicycontrol: Access to the Npcf_SMPolicyControl API

schemas

SmPolicyControl :

Type: object

Properties:

context:

Reference: '#/components/schemas/SmPolicyContextData'

policy:

Reference: '#/components/schemas/SmPolicyDecision'

Required:

- context

- policy

SmPolicyContextData

Type: object

Properties:

accNetChId:

Reference: '#/components/schemas/AccNetChId'

chargEntityAddr:

Reference: '#/components/schemas/AccNetChargingAddress'

gpsi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

supi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

interGrpIds:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/GroupId'

minItems: 1

pduSessionId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'

pduSessionType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'

chargingcharacteristics:

Type: string

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

notificationUri:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

accessType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType'

ratType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'

servingNetwork:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NetworkId'

userLocationInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'

ueTimeZone:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'

pei:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'

ipv4Address:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'

ipv6AddressPrefix:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'

ipDomain:

Type: string

Description: Indicates the IPv4 address domain

subsSessAmbr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ambr'

subsDefQos:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos'

numOfPackFilter:

Type: integer

Description: Contains the number of supported packet filter for signalled QoS rules.

online:

Type: boolean

Description: If it is included and set to true, the online charging is applied to the PDU session.

offline:

Type: boolean

Description: If it is included and set to true, the offline charging is applied to the PDU session.

3gppPsDataOffStatus:

Type: boolean

Description: If it is included and set to true, the 3GPP PS Data Off is activated by the UE.

refQosIndication:

Type: boolean

Description: If it is included and set to true, the reflective QoS is supported by the UE.

traceReq:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'

sliceInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

qosFlowUsage:

Reference: '#/components/schemas/QosFlowUsage'

suppFeat:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Required:

- supi

- pduSessionId

- pduSessionType

- dnn

- notificationUri

- sliceInfo

SmPolicyDecision

Type: object

Properties:

sessRules:

Type: object

additionalProperties:

Reference: '#/components/schemas/SessionRule'

minProperties: 1

Description: A map of Sessionrules with the content being the SessionRule as described in subclause 5.6.2.7.

pccRules:

Type: object

additionalProperties:

Reference: '#/components/schemas/PccRule'

minProperties: 1

Description: A map of PCC rules with the content being the PCCRule as described in subclause 5.6.2.6.

nullable: true

pcscfRestIndication:

Type: boolean

Description: If it is included and set to true, it indicates the P-CSCF Restoration is requested.

qosDecs:

Type: object

additionalProperties:

Reference: '#/components/schemas/QosData'

minProperties: 1

Description: Map of QoS data policy decisions.

chgDecs:

Type: object

additionalProperties:

Reference: '#/components/schemas/ChargingData'

minProperties: 1

Description: Map of Charging data policy decisions.

nullable: true

chargingInfo:

Reference: '#/components/schemas/ChargingInformation'

traffContDecs:

Type: object

additionalProperties:

Reference: '#/components/schemas/TrafficControlData'

minProperties: 1

Description: Map of Traffic Control data policy decisions.

umDecs:

Type: object

additionalProperties:

Reference: '#/components/schemas/UsageMonitoringData'

minProperties: 1

Description: Map of Usage Monitoring data policy decisions.

nullable: true

qosChars:

Type: object

additionalProperties:

Reference: '#/components/schemas/QosCharacteristics'

minProperties: 1

Description: Map of QoS characteristics for non standard 5QIs. This map uses the 5QI values as keys.

reflectiveQoSTimer:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'

conds:

Type: object

additionalProperties:

Reference: '#/components/schemas/ConditionData'

minProperties: 1

Description: A map of condition data with the content being as described in subclause 5.6.2.9.

nullable: true

revalidationTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

offline:

Type: boolean

Description: Indicates the offline charging is applicable to the PDU session or PCC rule.

online:

Type: boolean

Description: Indicates the online charging is applicable to the PDU session or PCC rule.

policyCtrlReqTriggers:

Type: array

Items:

Reference: '#/components/schemas/PolicyControlRequestTrigger'

minItems: 1

Description: Defines the policy control request triggers subscribed by the PCF.

nullable: true

lastReqRuleData:

Type: array

Items:

Reference: '#/components/schemas/RequestedRuleData'

minItems: 1

Description: Defines the last list of rule control data requested by the PCF.

lastReqUsageData:

Reference: '#/components/schemas/RequestedUsageData'

praInfos:

Type: object

additionalProperties:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm'

minProperties: 1

Description: Map of PRA information.

nullable: true

ipv4Index:

Reference: 'TS29519_ApplicationData.yaml#/components/schemas/IpIndex'

Description: Information that identifies which IP pool or external server is used to allocate the IPv4 address.

ipv6Index:

Reference: 'TS29519_ApplicationData.yaml#/components/schemas/IpIndex'

Description: Information that identifies which IP pool or external server is used to allocate the IPv6 address.

qosFlowUsage:

Reference: '#/components/schemas/QosFlowUsage'

suppFeat:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

SmPolicyNotification

Type: object

Properties:

resourceUri:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

smPolicyDecision:

Reference: '#/components/schemas/SmPolicyDecision'

PccRule

Type: object

Properties:

flowInfos:

Type: array

Items:

Reference: '#/components/schemas/FlowInformation'

minItems: 1

Description: An array of IP flow packet filter information.

appId:

Type: string

Description: A reference to the application detection filter configured at the UPF.

contVer:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion'

pccRuleId:

Type: string

Description: Univocally identifies the PCC rule within a PDU session.

precedence:

Type: integer

Description: Determines the order in which this PCC rule is applied relative to other PCC rules within the same PDU session.

afSigProtocol:

Reference: '#/components/schemas/AfSigProtocol'

nullable: true

appReloc:

Type: boolean

Description: Indication of application relocation possibility.

refQosData:

Type: array

Items:

Type: string

minItems: 1

maxItems: 1

Description: A reference to the QoSData policy type decision type. It is the qosId described in subclause 5.6.2.8. (NOTE)

refTcData:

Type: array

Items:

Type: string

minItems: 1

maxItems: 1

Description: A reference to the TrafficControlData policy decision type. It is the tcId described in subclause 5.6.2.10. (NOTE)

refChgData:

Type: array

Items:

Type: string

minItems: 1

maxItems: 1

Description: A reference to the ChargingData policy decision type. It is the chgId described in subclause 5.6.2.11. (NOTE)

nullable: true

refUmData:

Type: array

Items:

Type: string

minItems: 1

maxItems: 1

Description: A reference to UsageMonitoringData policy decision type. It is the umId described in subclause 5.6.2.12. (NOTE)

nullable: true

refCondData:

Type: string

Description: A reference to the condition data. It is the condId described in subclause 5.6.2.9.

nullable: true

Required:

- pccRuleId

nullable: true

SessionRule

Type: object

Properties:

authSessAmbr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ambr'

authDefQos:

Reference: '#/components/schemas/AuthorizedDefaultQos'

sessRuleId:

Type: string

Description: Univocally identifies the session rule within a PDU session.

refUmData:

Type: string

Description: A reference to UsageMonitoringData policy decision type. It is the umId described in subclause 5.6.2.12.

nullable: true

refCondData:

Type: string

Description: A reference to the condition data. It is the condId described in subclause 5.6.2.9.

nullable: true

Required:

- sessRuleId

nullable: true

QosData

Type: object

Properties:

qosId:

Type: string

Description: Univocally identifies the QoS control policy data within a PDU session.

5qi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5Qi'

maxbrUl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'

maxbrDl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'

gbrUl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'

gbrDl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'

arp:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Arp'

qnc:

Type: boolean

Description: Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.

priorityLevel:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm'

averWindow:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm'

maxDataBurstVol:

Reference: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm'

reflectiveQos:

Type: boolean

Description: Indicates whether the QoS information is reflective for the corresponding service data flow.

sharingKeyDl:

Type: string

Description: Indicates, by containing the same value, what PCC rules may share resource in downlink direction.

sharingKeyUl:

Type: string

Description: Indicates, by containing the same value, what PCC rules may share resource in uplink direction.

maxPacketLossRateDl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'

maxPacketLossRateUl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'

defQosFlowIndication:

Type: boolean

Description: Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule

Required:

- qosId

nullable: true

ConditionData

Type: object

Properties:

condId:

Type: string

Description: Uniquely identifies the condition data within a PDU session.

activationTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm'

deactivationTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm'

Required:

- condId

nullable: true

TrafficControlData

Type: object

Properties:

tcId:

Type: string

Description: Univocally identifies the traffic control policy data within a PDU session.

flowStatus:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus'

redirectInfo:

Reference: '#/components/schemas/RedirectInformation'

muteNotif:

Type: boolean

Description: Indicates whether applicat'on's start or stop notification is to be muted.

trafficSteeringPolIdDl:

Type: string

Description: Reference to a pre-configured traffic steering policy for downlink traffic at the SMF.

nullable: true

trafficSteeringPolIdUl:

Type: string

Description: Reference to a pre-configured traffic steering policy for uplink traffic at the SMF.

nullable: true

routeToLocs:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'

minItems: 1

Description: A list of location which the traffic shall be routed to for the AF request

upPathChgEvent:

Reference: '#/components/schemas/UpPathChgEvent'

Required:

- tcId

nullable: true

ChargingData

Type: object

Properties:

chgId:

Type: string

Description: Univocally identifies the charging control policy data within a PDU session.

meteringMethod:

Reference: '#/components/schemas/MeteringMethod'

nullable: true

offline:

Type: boolean

Description: Indicates the offline charging is applicable to the PDU session or PCC rule.

online:

Type: boolean

Description: Indicates the online charging is applicable to the PDU session or PCC rule.

ratingGroup:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup'

reportingLevel:

Reference: '#/components/schemas/ReportingLevel'

nullable: true

serviceId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ServiceId'

sponsorId:

Type: string

Description: Indicates the sponsor identity.

appSvcProvId:

Type: string

Description: Indicates the application service provider identity.

afChargingIdentifier:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'

Required:

- chgId

nullable: true

UsageMonitoringData

Type: object

Properties:

umId:

Type: string

Description: Univocally identifies the usage monitoring policy data within a PDU session.

volumeThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

volumeThresholdUplink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

volumeThresholdDownlink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

timeThreshold:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

monitoringTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm'

nextVolThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

nextVolThresholdUplink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

nextVolThresholdDownlink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm'

nextTimeThreshold:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

inactivityTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

exUsagePccRuleIds:

Type: array

Items:

Type: string

minItems: 1

Description: Contains the PCC rule identifier(s) which corresponding service data flow(s) shall be excluded from PDU Session usage monitoring. It is only included in the UsageMonitoringData instance for session level usage monitoring.

nullable: true

Required:

- umId

nullable: true

RedirectInformation

Type: object

Properties:

redirectEnabled:

Type: boolean

Description: Indicates the redirect is enable.

redirectAddressType:

Reference: '#/components/schemas/RedirectAddressType'

redirectServerAddress:

Type: string

Description: Indicates the address of the redirect server.

FlowInformation

Type: object

Properties:

flowDescription:

Reference: '#/components/schemas/FlowDescription'

ethFlowDescription:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'

Description: Defines a packet filter for an Ethernet flow. "fDir" attribute is not applicable.

packFiltId:

Type: string

Description: An identifier of packet filter.

packetFilterUsage:

Type: boolean

Description: The packet shall be sent to the UE.

tosTrafficClass:

Type: string

Description: Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field.

nullable: true

spi:

Type: string

Description: the security parameter index of the IPSec packet.

nullable: true

flowLabel:

Type: string

Description: the Ipv6 flow label header field.

nullable: true

flowDirection:

Reference: '#/components/schemas/FlowDirectionRm'

SmPolicyDeleteData

Type: object

Properties:

userLocationInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'

ueTimeZone:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'

servingNetwork:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NetworkId'

userLocationInfoTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

ranNasRelCauses:

Type: array

Items:

Reference: '#/components/schemas/RanNasRelCause'

minItems: 1

Description: Contains the RAN and/or NAS release cause.

accuUsageReports:

Type: array

Items:

Reference: '#/components/schemas/AccuUsageReport'

minItems: 1

Description: Contains the usage report

QosCharacteristics

Type: object

Properties:

5qi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5Qi'

resourceType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType'

priorityLevel:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel'

packetDelayBudget:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'

packetErrorRate:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'

averagingWindow:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AverWindow'

maxDataBurstVol:

Reference: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol'

Required:

- 5qi

- resourceType

- priorityLevel

- packetDelayBudget

- packetErrorRate

ChargingInformation

Type: object

Properties:

primaryChfAddress:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

secondaryChfAddress:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

Required:

- primaryChfAddress

- secondaryChfAddress

AccuUsageReport

Type: object

Properties:

refUmIds:

Type: string

Description: An id referencing UsageMonitoringData objects associated with this usage report.

volUsage:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

volUsageUplink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

volUsageDownlink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

timeUsage:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'

nextVolUsage:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

nextVolUsageUplink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

nextVolUsageDownlink:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Volume'

nextTimeUsage:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'

Required:

- refUmIds

SmPolicyUpdateContextData

Type: object

Properties:

repPolicyCtrlReqTriggers:

Type: array

Items:

Reference: '#/components/schemas/PolicyControlRequestTrigger'

minItems: 1

Description: The policy control reqeust trigges which are met.

accNetChIds:

Type: array

Items:

Reference: '#/components/schemas/AccNetChId'

minItems: 1

Description: Indicates the access network charging identifier for the PCC rule(s) or whole PDU session.

accessType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType'

ratType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'

servingNetwork:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NetworkId'

userLocationInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'

ueTimeZone:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'

relIpv4Address:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'

ipv4Address:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'

ipv6AddressPrefix:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'

relIpv6AddressPrefix:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'

relUeMac:

Reference: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'

ueMac:

Reference: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'

subsSessAmbr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ambr'

subsDefQos:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos'

numOfPackFilter:

Type: integer

Description: Contains the number of supported packet filter for signalled QoS rules.

accuUsageReports:

Type: array

Items:

Reference: '#/components/schemas/AccuUsageReport'

minItems: 1

Description: Contains the usage report

3gppPsDataOffStatus:

Type: boolean

Description: If it is included and set to true, the 3GPP PS Data Off is activated by the UE.

appDetectionInfos:

Type: array

Items:

Reference: '#/components/schemas/AppDetectionInfo'

minItems: 1

Description: Report the start/stop of the application traffic and detected SDF descriptions if applicable.

ruleReports:

Type: array

Items:

Reference: '#/components/schemas/RuleReport'

minItems: 1

Description: Used to report the PCC rule failure.

qncReports:

Type: array

Items:

Reference: '#/components/schemas/QosNotificationControlInfo'

minItems: 1

Description: QoS Notification Control information.

userLocationInfoTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

repPraInfos:

Type: object

additionalProperties:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'

minProperties: 1

Description: Reports the changes of presence reporting area.

ueInitResReq:

Reference: '#/components/schemas/UeInitiatedResourceRequest'

Description: Indicates a UE requests specific QoS handling for selected SDF.

refQosIndication:

Type: boolean

Description: If it is included and set to true, the reflective QoS is supported by the UE. If it is included and set to false, the reflective QoS is revoked by the UE.

qosFlowUsage:

Reference: '#/components/schemas/QosFlowUsage'

traceReq:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'

UpPathChgEvent

Type: object

Properties:

notificationUri:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

notifCorreId:

Type: string

Description: It is used to set the value of Notification Correlation ID in the notification sent by the SMF.

dnaiChgType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'

Required:

- notificationUri

- notifCorreId

- dnaiChgType

nullable: true

TerminationNotification

Type: object

Properties:

resourceUri:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

cause:

Reference: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/PolicyAssociationReleaseCause'

Required:

- resourceUri

- cause

AppDetectionInfo :

Type: object

Properties:

appId:

Type: string

Description: A reference to the application detection filter configured at the UPF

instanceId:

Type: string

Description: Identifier dynamically assigned by the SMF in order to allow correlation of application Start and Stop events to the specific service data flow description, if service data flow descriptions are deducible.

sdfDescriptions:

Type: array

Items:

Reference: '#/components/schemas/FlowInformation'

minItems: 1

Description: Contains the detected service data flow descriptions if they are deducible.

Required:

- appId

AccNetChId

Type: object

Properties:

accNetChaIdValue:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'

refPccRuleIds:

Type: array

Items:

Type: string

minItems: 1

Description: Contains the identifier of the PCC rule(s) associated to the provided Access Network Charging Identifier.

sessionChScope:

Type: boolean

Description: When it is included and set to true, indicates the Access Network Charging Identifier applies to the whole PDU Session

Required:

- accNetChaIdValue

AccNetChargingAddress

Description: Describes the network entity within the access network performing charging

Type: object

anyOf:

- required: [anChargIpv4Addr]

- required: [anChargIpv6Addr]

Properties:

anChargIpv4Addr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'

anChargIpv6Addr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'

RequestedRuleData

Type: object

Properties:

refPccRuleIds:

Type: array

Items:

Type: string

minItems: 1

Description: An array of PCC rule id references to the PCC rules associated with the control data.

reqData:

Type: array

Items:

Reference: '#/components/schemas/RequestedRuleDataType'

minItems: 1

Description: Array of requested rule data type elements indicating what type of rule data is requested for the corresponding referenced PCC rules.

Required:

- refPccRuleIds

- reqData

RequestedUsageData

Type: object

Properties:

refUmIds:

Type: array

Items:

Type: string

minItems: 1

Description: An array of usage monitoring data id references to the usage monitoring data instances for which the PCF is requesting a usage report. This attribute shall only be provided when allUmIds is not set to true.

allUmIds:

Type: boolean

Description: Th ooleanean indicates whether requested usage data applies to all usage monitoring data instances. When it's not included, it means requested usage data shall only apply to the usage monitoring data instances referenced by the refUmIds attribute.

UeCampingRep

Type: object

Properties:

accessType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType'

Description: The Access Type where the served UE is camping

ratType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'

servingNetwork:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NetworkId'

userLocationInfo:

Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'

ueTimeZone:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'

RuleReport

Type: object

Properties:

pccRuleIds:

Type: array

Items:

Type: string

minItems: 1

Description: Contains the identifier of the affected PCC rule(s).

ruleStatus:

Reference: '#/components/schemas/RuleStatus'

Description: Indicates the status of the PCC rule(s).

contVers:

Type: array

Items:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion'

minItems: 1

Description: Indicates the version of a PCC rule.

failureCode:

Reference: '#/components/schemas/FailureCode'

Description: Indicates the reason tha the PCC Rule is being reported.

finUnitAct:

Reference: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction'

Description: Contains the related filter parameters and redirect address parameters (if available), when the user's account cannot cover the service cost.

ranNasRelCauses:

Type: array

Items:

Reference: '#/components/schemas/RanNasRelCause'

minItems: 1

Description: indicates the RAN or NAS release cause code information.

Required:

- pccRuleIds

- ruleStatus

- failureCode

RanNasRelCause

Type: object

Properties:

ngApCause:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NgApCause'

Description: Indicate the cause value for NGAP protocol.

5gMmCause:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause'

Description: Indicate the cause value for 5GMM protocol.

5gSmCause:

Reference: '#/components/schemas/5GSmCause'

Description: Indicate the cause value for 5GSM protocol.

UeInitiatedResourceRequest

Type: object

Properties:

packFiltOp:

Reference: '#/components/schemas/PacketFilterOperation'

Description: Indicates a UE requests specific QoS handling for selected SDF.

packFiltInfo:

Type: array

Items:

Reference: '#/components/schemas/PacketFilterInfo'

Description: Contains the information from a single packet filter sent from the SMF to the PCF.

minItems: 1

reqQos:

Reference: '#/components/schemas/RequestedQos'

Description: Contains the QoS information requested by the UE.

Required:

- packFiltOp

- packFiltInfo

PacketFilterInfo

Type: object

Properties:

packFiltId:

Type: string

Description: An identifier of packet filter.

precedence:

Type: integer

Description: The requested order for the PCC rule generated fromt the packet fitler information.

packFiltCont:

Reference: '#/components/schemas/PacketFilterContent'

Description: Contains the content of the packet filter as requested by the UE and required by the PCF to create the PCC rules.

tosTrafficClass:

Type: string

Description: Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field.

spi:

Type: string

Description: The security parameter index of the IPSec packet.

flowLabel:

Type: string

Description: The Ipv6 flow label header field.

flowDirection:

Reference: '#/components/schemas/FlowDirection'

Description: Indicates the direction/directions that a filter is applicable, downlink only, uplink only or both down- and uplink (bidirectional).

RequestedQos

Type: object

Properties:

5qi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5Qi'

Description: Identifier for the authorized QoS parameters for the service data flow.

gbrUl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRate'

Description: Indicates the guaranteed bandwidth in uplink requested by the UE.

gbrDl:

Reference: 'TS29571_CommonData.yaml#/components/schemas/BitRate'

Description: Indicates the guaranteed bandwidth in downlink requested by the UE.

Required:

- 5qi

QosNotificationControlInfo

Type: object

Properties:

refPccRuleIds:

Type: array

Items:

Type: string

minItems: 1

Description: An array of PCC rule id references to the PCC rules associated with the QoS notification control info.

notifType:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosNotifType'

contVer:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion'

Required:

- refPccRuleIds

- notifType

PartialSuccessReport

Type: object

Properties:

failureCause:

Type: string

Description: Application error cause specific to this report.

ruleReports:

Type: array

Items:

Reference: '#/components/schemas/RuleReport'

minItems: 1

Description: Information about the PCC rules provisioned by the PCF not successfully installed/activated.

ueCampingRep:

Reference: '#/components/schemas/UeCampingRep'

Description: Includes the current applicable values corresponding to the provisioned policy control request triggers.

Required:

- failureCause

- ruleReports

AuthorizedDefaultQos

Type: object

Properties:

5qi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5Qi'

Description: Identifier for the 5QI.

arp:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Arp'

priorityLevel:

Reference: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm'

averWindow:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm'

maxDataBurstVol:

Reference: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm'

ErrorReport

Type: object

Properties:

error:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

ruleReports:

Type: array

Items:

Reference: '#/components/schemas/RuleReport'

minItems: 1

Description: Used to report the PCC rule failure.

5GSmCause

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

Description: Indicating the cause value of 5GSM protocol.

PacketFilterContent

Type: string

Description: Defines a packet filter for an IP flow.Refer to subclause 5.3.54 of 3GPP TS 29.212 [23] for encoding.

FlowDescription

Type: string

Description: Defines a packet filter for an IP flow.Refer to subclause 5.4.2 of 3GPP TS 29.212 [23] for encoding.

FlowDirection

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- DOWNLINK: The corresponding filter applies for traffic to the UE.

- UPLINK: The corresponding filter applies for traffic from the UE.

- BIDIRECTIONAL: The corresponding filter applies for traffic both to and from the UE.

- UNSPECIFIED: The corresponding filter applies for traffic to the UE (downlink), but has no specific direction declared. The service data flow detection shall apply the filter for uplink traffic as if the filter was bidirectional. The PCF shall not use the value UNSPECIFIED in filters created by the network in NW-initiated procedures. The PCF shall only include the value UNSPECIFIED in filters in UE-initiated procedures if the same value is received from the SMF.

FlowDirectionRm

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- DOWNLINK: The corresponding filter applies for traffic to the UE.

- UPLINK: The corresponding filter applies for traffic from the UE.

- BIDIRECTIONAL: The corresponding filter applies for traffic both to and from the UE.

- UNSPECIFIED: The corresponding filter applies for traffic to the UE (downlink), but has no specific direction declared. The service data flow detection shall apply the filter for uplink traffic as if the filter was bidirectional. The PCF shall not use the value UNSPECIFIED in filters created by the network in NW-initiated procedures. The PCF shall only include the value UNSPECIFIED in filters in UE-initiated procedures if the same value is received from the SMF.

nullable: true

ReportingLevel

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- SER_ID_LEVEL: Indicates that the usage shall be reported on service id and rating group combination level.

- RAT_GR_LEVEL: Indicates that the usage shall be reported on rating group level.

- SPON_CON_LEVEL: Indicates that the usage shall be reported on sponsor identity and rating group combination level.

MeteringMethod

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- DURATION: Indicates that the duration of the service data flow traffic shall be metered.

- VOLUME: Indicates that volume of the service data flow traffic shall be metered.

- DURATION_VOLUME: Indicates that the duration and the volume of the service data flow traffic shall be metered.

- EVENT: Indicates that events of the service data flow traffic shall be metered.

PolicyControlRequestTrigger

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- PLMN_CH: PLMN Change

- RES_MO_RE: A request for resource modification has been received by the SMF. The SMF always reports to the PCF.

- AC_TY_CH: Access Type Change

- UE_IP_CH: UE IP address change. The SMF always reports to the PCF.

- UE_MAC_CH: A new UE MAC address is detected or a used UE MAC address is inactive for a specific period

- AN_CH_COR: Access Network Charging Correlation Information

- US_RE: The PDU Session or the Monitoring key specific resources consumed by a UE either reached the threshold or needs to be reported for other reasons.

- APP_STA: The start of application traffic has been detected.

- APP_STO: The stop of application traffic has been detected.

- AN_INFO: Access Network Information report

- CM_SES_FAIL: Credit management session failure

- PS_DA_OFF: The SMF reports when the 3GPP PS Data Off status changes. The SMF always reports to the PCF.

- DEF_QOS_CH: Default QoS Change. The SMF always reports to the PCF.

- SE_AMBR_CH: Session AMBR Change. The SMF always reports to the PCF.

- QOS_NOTIF: The SMF notify the PCF when receiving notification from RAN that QoS targets of the QoS Flow cannot be guranteed or gurateed again.

- NO_CREDIT: Out of credit

- PRA_CH: Change of UE presence in Presence Reporting Area

- SAREA_CH: Location Change with respect to the Serving Area

- SCNN_CH: Location Change with respect to the Serving CN node

- RE_TIMEOUT: Indicates the SMF generated the request because there has been a PCC revalidation timeout

- RES_RELEASE: Indicate that the SMF can inform the PCF of the outcome of the release of resources for those rules that require so.

- SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation.

- RAT_TY_CH: RAT Type Change.

- REF_QOS_IND_CH: Reflective QoS indication Change

RequestedRuleDataType

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- CH_ID: Indicates that the requested rule data is the charging identifier.

- MS_TIME_ZONE: Indicates that the requested access network info type is the UE's timezone.

- USER_LOC_INFO: Indicates that the requested access network info type is the UE's location.

- RES_RELEASE: Indicates that the requested rule data is the result of the release of resource.

- SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation.

RuleStatus

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- ACTIVE: Indicates that the PCC rule(s) are successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF), or the session rule(s) are successfully installed

- INACTIVE: Indicates that the PCC rule(s) are removed (for those provisioned from PCF) or inactive (for those pre-defined in SMF) or the session rule(s) are removed.

FailureCode

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- UNK_RULE_ID: Indicates that the pre-provisioned PCC rule could not be successfully activated because the PCC rule identifier is unknown to the SMF.

- RA_GR_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Rating Group specified within the Charging Data policy decision which the PCC rule refers to is unknown or, invalid.

- SER_ID_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Service Identifier specified within the Charging Data policy decision which the PCC rule refers to is invalid, unknown, or not applicable to the service being charged.

- NF_MAL: Indicate that the PCC rule could not be successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction.

- RES_LIM: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF.

- MAX_NR_QoS_FLOW: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to the fact that the maximum number of QoS flows has been reached for the PDU session.

- MISS_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or enforced because the Flow Information AVP is not specified within the "pccRule" attribute by the PCF during the first install request of the PCC rule.

- RES_ALLO_FAIL: Indicate that the PCC rule could not be successfully installed or maintained since the QoS flow establishment/modification failed, or the QoS flow was released.

- UNSUCC_QOS_VAL: indicate that the QoS validation has failed or when Guaranteed Bandwidth > Max-Requested-Bandwidth.

- INCOR_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or modified at the SMF because the provided flow information is not supported by the network (e.g. the provided IP address(es) or Ipv6 prefix(es) do not correspond to an IP version applicable for the PDU session).

- PS_TO_CS_HAN: Indicate that the PCC rule could not be maintained because of PS to CS handover.

- APP_ID_ERR: Indicate that the rule could not be successfully installed or enforced because the Application Identifier is invalid, unknown, or not applicable to the application required for detection.

- NO_QOS_FLOW_BOUND: Indicate that there is no QoS flow which the SMF can bind the PCC rule(s) to.

- FILTER_RES: Indicate that the Flow Information cannot be handled by the SMF because any of the restrictions was not met.

- MISS_REDI_SER_ADDR: Indicate that the PCC rule could not be successfully installed or enforced at the SMF because there is no valid Redirect Server Address within the Traffic Control Data policy decision which the PCC rule refers to provided by the PCF and no preconfigured redirection address for this PCC rule at the SMF.

- CM_END_USER_SER_DENIED: Indicate that the charging system denied the service request due to service restrictions (e.g. terminate rating group) or limitations related to the end-user, for example the end-user's account could not cover the requested service.

- CM_CREDIT_CON_NOT_APP: Indicate that the charging system determined that the service can be granted to the end user but no further credit control is needed for the service (e.g. service is free of charge or is treated for offline charging).

- CM_AUTH_REJ: Indicate that the charging system denied the service request in order to terminate the service for which credit is requested.

- CM_USER_UNK: Indicate that the specified end user could not be found in the charging system.

- CM_RAT_FAILED: Indicate that the charging system cannot rate the service request due to insufficient rating input, incorrect AVP combination or due to an attribute or an attribute value that is not recognized or supported in the rating.

- SESS_AMBR_FAILURE: Indicate that the session AMBR update is failure.

- DEF_QOS_FAILURL: Indicate that the default QoS update is failure.

AfSigProtocol

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- NO_INFORMATION: Indicate that no information about the AF signalling protocol is being provided.

- SIP: Indicate that the signalling protocol is Session Initiation Protocol.

PacketFilterOperation

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- DELETION: Indicates that the resources reserved for the provided packet filter identifiers are to be deleted and are no longer used by the UE.

- ADDITION: Indicates that the UE requests resources allocated for the provided packet filters.

- MODIFICATION: Indicates that the reserved QoS, the filter, the precedence, or any of the fields for the provided packet filter identifiers are being modified.

RedirectAddressType

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- IPV4_ADDR: Indicates that the address type is in the form of "dotted-decimal" IPv4 address.

- IPV6_ADDR: Indicates that the address type is in the form of IPv6 address.

- URL: Indicates that the address type is in the form of Uniform Resource Locator.

- SIP_URI: Indicates that the address type is in the form of SIP Uniform Resource Identifier.

QosFlowUsage

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- GENERAL: Indicate no specific QoS flow usage information is available.

- IMS_SIG: Indicate that the QoS flow is used for IMS signalling only.